snowflake.JobService
Explore with Pulumi AI
Import
$ pulumi import snowflake:index/jobService:JobService example '"<database_name>"."<schema_name>"."<job_service_name>"'
Create JobService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new JobService(name: string, args: JobServiceArgs, opts?: CustomResourceOptions);
@overload
def JobService(resource_name: str,
args: JobServiceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def JobService(resource_name: str,
opts: Optional[ResourceOptions] = None,
compute_pool: Optional[str] = None,
database: Optional[str] = None,
schema: Optional[str] = None,
comment: Optional[str] = None,
external_access_integrations: Optional[Sequence[str]] = None,
from_specification: Optional[JobServiceFromSpecificationArgs] = None,
from_specification_template: Optional[JobServiceFromSpecificationTemplateArgs] = None,
name: Optional[str] = None,
query_warehouse: Optional[str] = None)
func NewJobService(ctx *Context, name string, args JobServiceArgs, opts ...ResourceOption) (*JobService, error)
public JobService(string name, JobServiceArgs args, CustomResourceOptions? opts = null)
public JobService(String name, JobServiceArgs args)
public JobService(String name, JobServiceArgs args, CustomResourceOptions options)
type: snowflake:JobService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args JobServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args JobServiceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args JobServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JobServiceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var jobServiceResource = new Snowflake.JobService("jobServiceResource", new()
{
ComputePool = "string",
Database = "string",
Schema = "string",
Comment = "string",
ExternalAccessIntegrations = new[]
{
"string",
},
FromSpecification = new Snowflake.Inputs.JobServiceFromSpecificationArgs
{
File = "string",
Path = "string",
Stage = "string",
Text = "string",
},
FromSpecificationTemplate = new Snowflake.Inputs.JobServiceFromSpecificationTemplateArgs
{
Usings = new[]
{
new Snowflake.Inputs.JobServiceFromSpecificationTemplateUsingArgs
{
Key = "string",
Value = "string",
},
},
File = "string",
Path = "string",
Stage = "string",
Text = "string",
},
Name = "string",
QueryWarehouse = "string",
});
example, err := snowflake.NewJobService(ctx, "jobServiceResource", &snowflake.JobServiceArgs{
ComputePool: pulumi.String("string"),
Database: pulumi.String("string"),
Schema: pulumi.String("string"),
Comment: pulumi.String("string"),
ExternalAccessIntegrations: pulumi.StringArray{
pulumi.String("string"),
},
FromSpecification: &snowflake.JobServiceFromSpecificationArgs{
File: pulumi.String("string"),
Path: pulumi.String("string"),
Stage: pulumi.String("string"),
Text: pulumi.String("string"),
},
FromSpecificationTemplate: &snowflake.JobServiceFromSpecificationTemplateArgs{
Usings: snowflake.JobServiceFromSpecificationTemplateUsingArray{
&snowflake.JobServiceFromSpecificationTemplateUsingArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
File: pulumi.String("string"),
Path: pulumi.String("string"),
Stage: pulumi.String("string"),
Text: pulumi.String("string"),
},
Name: pulumi.String("string"),
QueryWarehouse: pulumi.String("string"),
})
var jobServiceResource = new JobService("jobServiceResource", JobServiceArgs.builder()
.computePool("string")
.database("string")
.schema("string")
.comment("string")
.externalAccessIntegrations("string")
.fromSpecification(JobServiceFromSpecificationArgs.builder()
.file("string")
.path("string")
.stage("string")
.text("string")
.build())
.fromSpecificationTemplate(JobServiceFromSpecificationTemplateArgs.builder()
.usings(JobServiceFromSpecificationTemplateUsingArgs.builder()
.key("string")
.value("string")
.build())
.file("string")
.path("string")
.stage("string")
.text("string")
.build())
.name("string")
.queryWarehouse("string")
.build());
job_service_resource = snowflake.JobService("jobServiceResource",
compute_pool="string",
database="string",
schema="string",
comment="string",
external_access_integrations=["string"],
from_specification={
"file": "string",
"path": "string",
"stage": "string",
"text": "string",
},
from_specification_template={
"usings": [{
"key": "string",
"value": "string",
}],
"file": "string",
"path": "string",
"stage": "string",
"text": "string",
},
name="string",
query_warehouse="string")
const jobServiceResource = new snowflake.JobService("jobServiceResource", {
computePool: "string",
database: "string",
schema: "string",
comment: "string",
externalAccessIntegrations: ["string"],
fromSpecification: {
file: "string",
path: "string",
stage: "string",
text: "string",
},
fromSpecificationTemplate: {
usings: [{
key: "string",
value: "string",
}],
file: "string",
path: "string",
stage: "string",
text: "string",
},
name: "string",
queryWarehouse: "string",
});
type: snowflake:JobService
properties:
comment: string
computePool: string
database: string
externalAccessIntegrations:
- string
fromSpecification:
file: string
path: string
stage: string
text: string
fromSpecificationTemplate:
file: string
path: string
stage: string
text: string
usings:
- key: string
value: string
name: string
queryWarehouse: string
schema: string
JobService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The JobService resource accepts the following input properties:
- Compute
Pool string - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Database string
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Schema string
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Comment string
- Specifies a comment for the service.
- External
Access List<string>Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- From
Specification JobService From Specification - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- From
Specification JobTemplate Service From Specification Template - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- Name string
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Query
Warehouse string - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
.
- Compute
Pool string - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Database string
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Schema string
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Comment string
- Specifies a comment for the service.
- External
Access []stringIntegrations - Specifies the names of the external access integrations that allow your service to access external sites.
- From
Specification JobService From Specification Args - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- From
Specification JobTemplate Service From Specification Template Args - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- Name string
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Query
Warehouse string - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
.
- compute
Pool String - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database String
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema String
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - comment String
- Specifies a comment for the service.
- external
Access List<String>Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from
Specification JobService From Specification - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from
Specification JobTemplate Service From Specification Template - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- name String
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query
Warehouse String - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
.
- compute
Pool string - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database string
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema string
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - comment string
- Specifies a comment for the service.
- external
Access string[]Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from
Specification JobService From Specification - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from
Specification JobTemplate Service From Specification Template - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- name string
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query
Warehouse string - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
.
- compute_
pool str - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database str
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema str
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - comment str
- Specifies a comment for the service.
- external_
access_ Sequence[str]integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from_
specification JobService From Specification Args - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from_
specification_ Jobtemplate Service From Specification Template Args - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- name str
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query_
warehouse str - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
.
- compute
Pool String - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database String
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema String
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - comment String
- Specifies a comment for the service.
- external
Access List<String>Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from
Specification Property Map - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from
Specification Property MapTemplate - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- name String
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query
Warehouse String - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
.
Outputs
All input properties are implicitly available as output properties. Additionally, the JobService resource produces the following output properties:
- Describe
Outputs List<JobService Describe Output> - Outputs the result of
DESCRIBE SERVICE
for the given service. - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Type string - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- Show
Outputs List<JobService Show Output> - Outputs the result of
SHOW SERVICES
for the given service.
- Describe
Outputs []JobService Describe Output - Outputs the result of
DESCRIBE SERVICE
for the given service. - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Type string - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- Show
Outputs []JobService Show Output - Outputs the result of
SHOW SERVICES
for the given service.
- describe
Outputs List<JobService Describe Output> - Outputs the result of
DESCRIBE SERVICE
for the given service. - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- service
Type String - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show
Outputs List<JobService Show Output> - Outputs the result of
SHOW SERVICES
for the given service.
- describe
Outputs JobService Describe Output[] - Outputs the result of
DESCRIBE SERVICE
for the given service. - fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- service
Type string - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show
Outputs JobService Show Output[] - Outputs the result of
SHOW SERVICES
for the given service.
- describe_
outputs Sequence[JobService Describe Output] - Outputs the result of
DESCRIBE SERVICE
for the given service. - fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- service_
type str - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show_
outputs Sequence[JobService Show Output] - Outputs the result of
SHOW SERVICES
for the given service.
- describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE SERVICE
for the given service. - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- service
Type String - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show
Outputs List<Property Map> - Outputs the result of
SHOW SERVICES
for the given service.
Look up Existing JobService Resource
Get an existing JobService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: JobServiceState, opts?: CustomResourceOptions): JobService
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
compute_pool: Optional[str] = None,
database: Optional[str] = None,
describe_outputs: Optional[Sequence[JobServiceDescribeOutputArgs]] = None,
external_access_integrations: Optional[Sequence[str]] = None,
from_specification: Optional[JobServiceFromSpecificationArgs] = None,
from_specification_template: Optional[JobServiceFromSpecificationTemplateArgs] = None,
fully_qualified_name: Optional[str] = None,
name: Optional[str] = None,
query_warehouse: Optional[str] = None,
schema: Optional[str] = None,
service_type: Optional[str] = None,
show_outputs: Optional[Sequence[JobServiceShowOutputArgs]] = None) -> JobService
func GetJobService(ctx *Context, name string, id IDInput, state *JobServiceState, opts ...ResourceOption) (*JobService, error)
public static JobService Get(string name, Input<string> id, JobServiceState? state, CustomResourceOptions? opts = null)
public static JobService get(String name, Output<String> id, JobServiceState state, CustomResourceOptions options)
resources: _: type: snowflake:JobService get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Comment string
- Specifies a comment for the service.
- Compute
Pool string - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Database string
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Describe
Outputs List<JobService Describe Output> - Outputs the result of
DESCRIBE SERVICE
for the given service. - External
Access List<string>Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- From
Specification JobService From Specification - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- From
Specification JobTemplate Service From Specification Template - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Query
Warehouse string - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Schema string
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Service
Type string - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- Show
Outputs List<JobService Show Output> - Outputs the result of
SHOW SERVICES
for the given service.
- Comment string
- Specifies a comment for the service.
- Compute
Pool string - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Database string
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Describe
Outputs []JobService Describe Output Args - Outputs the result of
DESCRIBE SERVICE
for the given service. - External
Access []stringIntegrations - Specifies the names of the external access integrations that allow your service to access external sites.
- From
Specification JobService From Specification Args - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- From
Specification JobTemplate Service From Specification Template Args - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Query
Warehouse string - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Schema string
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - Service
Type string - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- Show
Outputs []JobService Show Output Args - Outputs the result of
SHOW SERVICES
for the given service.
- comment String
- Specifies a comment for the service.
- compute
Pool String - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database String
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - describe
Outputs List<JobService Describe Output> - Outputs the result of
DESCRIBE SERVICE
for the given service. - external
Access List<String>Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from
Specification JobService From Specification - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from
Specification JobTemplate Service From Specification Template - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query
Warehouse String - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema String
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - service
Type String - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show
Outputs List<JobService Show Output> - Outputs the result of
SHOW SERVICES
for the given service.
- comment string
- Specifies a comment for the service.
- compute
Pool string - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database string
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - describe
Outputs JobService Describe Output[] - Outputs the result of
DESCRIBE SERVICE
for the given service. - external
Access string[]Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from
Specification JobService From Specification - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from
Specification JobTemplate Service From Specification Template - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- name string
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query
Warehouse string - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema string
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - service
Type string - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show
Outputs JobService Show Output[] - Outputs the result of
SHOW SERVICES
for the given service.
- comment str
- Specifies a comment for the service.
- compute_
pool str - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database str
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - describe_
outputs Sequence[JobService Describe Output Args] - Outputs the result of
DESCRIBE SERVICE
for the given service. - external_
access_ Sequence[str]integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from_
specification JobService From Specification Args - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from_
specification_ Jobtemplate Service From Specification Template Args - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- name str
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query_
warehouse str - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema str
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - service_
type str - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show_
outputs Sequence[JobService Show Output Args] - Outputs the result of
SHOW SERVICES
for the given service.
- comment String
- Specifies a comment for the service.
- compute
Pool String - Specifies the name of the compute pool in your account on which to run the service. Identifiers with special or lower-case characters are not supported. This limitation in the provider follows the limitation in Snowflake (see docs). Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - database String
- The database in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE SERVICE
for the given service. - external
Access List<String>Integrations - Specifies the names of the external access integrations that allow your service to access external sites.
- from
Specification Property Map - Specifies the service specification to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- from
Specification Property MapTemplate - Specifies the service specification template to use for the service. Note that external changes on this field and nested fields are not detected. Use correctly formatted YAML files. Watch out for the space/tabs indentation. See service specification for more information.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the identifier for the service; must be unique for the schema in which the service is created. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - query
Warehouse String - Warehouse to use if a service container connects to Snowflake to execute a query but does not explicitly specify a warehouse to use. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - schema String
- The schema in which to create the service. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. - service
Type String - Specifies a type for the service. This field is used for checking external changes and recreating the resources if needed.
- show
Outputs List<Property Map> - Outputs the result of
SHOW SERVICES
for the given service.
Supporting Types
JobServiceDescribeOutput, JobServiceDescribeOutputArgs
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Compute
Pool string - Created
On string - Current
Instances int - Database
Name string - Dns
Name string - External
Access List<string>Integrations - Is
Async boolJob - Is
Job bool - Is
Upgrading bool - Managing
Object stringDomain - Managing
Object stringName - Max
Instances int - Min
Instances int - Min
Ready intInstances - Name string
- Owner string
- Owner
Role stringType - Query
Warehouse string - Resumed
On string - Schema
Name string - Spec string
- Spec
Digest string - Status string
- Suspended
On string - Target
Instances int - Updated
On string
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Compute
Pool string - Created
On string - Current
Instances int - Database
Name string - Dns
Name string - External
Access []stringIntegrations - Is
Async boolJob - Is
Job bool - Is
Upgrading bool - Managing
Object stringDomain - Managing
Object stringName - Max
Instances int - Min
Instances int - Min
Ready intInstances - Name string
- Owner string
- Owner
Role stringType - Query
Warehouse string - Resumed
On string - Schema
Name string - Spec string
- Spec
Digest string - Status string
- Suspended
On string - Target
Instances int - Updated
On string
- auto
Resume Boolean - auto
Suspend IntegerSecs - comment String
- compute
Pool String - created
On String - current
Instances Integer - database
Name String - dns
Name String - external
Access List<String>Integrations - is
Async BooleanJob - is
Job Boolean - is
Upgrading Boolean - managing
Object StringDomain - managing
Object StringName - max
Instances Integer - min
Instances Integer - min
Ready IntegerInstances - name String
- owner String
- owner
Role StringType - query
Warehouse String - resumed
On String - schema
Name String - spec String
- spec
Digest String - status String
- suspended
On String - target
Instances Integer - updated
On String
- auto
Resume boolean - auto
Suspend numberSecs - comment string
- compute
Pool string - created
On string - current
Instances number - database
Name string - dns
Name string - external
Access string[]Integrations - is
Async booleanJob - is
Job boolean - is
Upgrading boolean - managing
Object stringDomain - managing
Object stringName - max
Instances number - min
Instances number - min
Ready numberInstances - name string
- owner string
- owner
Role stringType - query
Warehouse string - resumed
On string - schema
Name string - spec string
- spec
Digest string - status string
- suspended
On string - target
Instances number - updated
On string
- auto_
resume bool - auto_
suspend_ intsecs - comment str
- compute_
pool str - created_
on str - current_
instances int - database_
name str - dns_
name str - external_
access_ Sequence[str]integrations - is_
async_ booljob - is_
job bool - is_
upgrading bool - managing_
object_ strdomain - managing_
object_ strname - max_
instances int - min_
instances int - min_
ready_ intinstances - name str
- owner str
- owner_
role_ strtype - query_
warehouse str - resumed_
on str - schema_
name str - spec str
- spec_
digest str - status str
- suspended_
on str - target_
instances int - updated_
on str
- auto
Resume Boolean - auto
Suspend NumberSecs - comment String
- compute
Pool String - created
On String - current
Instances Number - database
Name String - dns
Name String - external
Access List<String>Integrations - is
Async BooleanJob - is
Job Boolean - is
Upgrading Boolean - managing
Object StringDomain - managing
Object StringName - max
Instances Number - min
Instances Number - min
Ready NumberInstances - name String
- owner String
- owner
Role StringType - query
Warehouse String - resumed
On String - schema
Name String - spec String
- spec
Digest String - status String
- suspended
On String - target
Instances Number - updated
On String
JobServiceFromSpecification, JobServiceFromSpecificationArgs
- File string
- The file name of the service specification. Example:
spec.yaml
. - Path string
- The path to the service specification file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - Stage string
- The fully qualified name of the stage containing the service specification file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - Text string
- The embedded text of the service specification.
- File string
- The file name of the service specification. Example:
spec.yaml
. - Path string
- The path to the service specification file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - Stage string
- The fully qualified name of the stage containing the service specification file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - Text string
- The embedded text of the service specification.
- file String
- The file name of the service specification. Example:
spec.yaml
. - path String
- The path to the service specification file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage String
- The fully qualified name of the stage containing the service specification file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text String
- The embedded text of the service specification.
- file string
- The file name of the service specification. Example:
spec.yaml
. - path string
- The path to the service specification file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage string
- The fully qualified name of the stage containing the service specification file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text string
- The embedded text of the service specification.
- file str
- The file name of the service specification. Example:
spec.yaml
. - path str
- The path to the service specification file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage str
- The fully qualified name of the stage containing the service specification file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text str
- The embedded text of the service specification.
- file String
- The file name of the service specification. Example:
spec.yaml
. - path String
- The path to the service specification file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage String
- The fully qualified name of the stage containing the service specification file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text String
- The embedded text of the service specification.
JobServiceFromSpecificationTemplate, JobServiceFromSpecificationTemplateArgs
- Usings
List<Job
Service From Specification Template Using> - List of the specified template variables and the values of those variables.
- File string
- The file name of the service specification template. Example:
spec.yaml
. - Path string
- The path to the service specification template file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - Stage string
- The fully qualified name of the stage containing the service specification template file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - Text string
- The embedded text of the service specification template.
- Usings
[]Job
Service From Specification Template Using - List of the specified template variables and the values of those variables.
- File string
- The file name of the service specification template. Example:
spec.yaml
. - Path string
- The path to the service specification template file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - Stage string
- The fully qualified name of the stage containing the service specification template file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - Text string
- The embedded text of the service specification template.
- usings
List<Job
Service From Specification Template Using> - List of the specified template variables and the values of those variables.
- file String
- The file name of the service specification template. Example:
spec.yaml
. - path String
- The path to the service specification template file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage String
- The fully qualified name of the stage containing the service specification template file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text String
- The embedded text of the service specification template.
- usings
Job
Service From Specification Template Using[] - List of the specified template variables and the values of those variables.
- file string
- The file name of the service specification template. Example:
spec.yaml
. - path string
- The path to the service specification template file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage string
- The fully qualified name of the stage containing the service specification template file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text string
- The embedded text of the service specification template.
- usings
Sequence[Job
Service From Specification Template Using] - List of the specified template variables and the values of those variables.
- file str
- The file name of the service specification template. Example:
spec.yaml
. - path str
- The path to the service specification template file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage str
- The fully qualified name of the stage containing the service specification template file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text str
- The embedded text of the service specification template.
- usings List<Property Map>
- List of the specified template variables and the values of those variables.
- file String
- The file name of the service specification template. Example:
spec.yaml
. - path String
- The path to the service specification template file on the given stage. When the path is specified, the
/
character is automatically added as a path prefix. Example:path/to/spec
. - stage String
- The fully qualified name of the stage containing the service specification template file. At symbol (
@
) is added automatically. Example:"\"<db_name>\".\"<schema_name>\".\"<stage_name>\""
. For more information about this resource, see docs. - text String
- The embedded text of the service specification template.
JobServiceFromSpecificationTemplateUsing, JobServiceFromSpecificationTemplateUsingArgs
- Key string
- The name of the template variable. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the spec definition.
- Value string
- The value to assign to the variable in the template. The provider wraps it in
$$
by default, so be aware of that while referencing the argument in the spec definition. The value must either be alphanumeric or valid JSON.
- Key string
- The name of the template variable. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the spec definition.
- Value string
- The value to assign to the variable in the template. The provider wraps it in
$$
by default, so be aware of that while referencing the argument in the spec definition. The value must either be alphanumeric or valid JSON.
- key String
- The name of the template variable. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the spec definition.
- value String
- The value to assign to the variable in the template. The provider wraps it in
$$
by default, so be aware of that while referencing the argument in the spec definition. The value must either be alphanumeric or valid JSON.
- key string
- The name of the template variable. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the spec definition.
- value string
- The value to assign to the variable in the template. The provider wraps it in
$$
by default, so be aware of that while referencing the argument in the spec definition. The value must either be alphanumeric or valid JSON.
- key str
- The name of the template variable. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the spec definition.
- value str
- The value to assign to the variable in the template. The provider wraps it in
$$
by default, so be aware of that while referencing the argument in the spec definition. The value must either be alphanumeric or valid JSON.
- key String
- The name of the template variable. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the spec definition.
- value String
- The value to assign to the variable in the template. The provider wraps it in
$$
by default, so be aware of that while referencing the argument in the spec definition. The value must either be alphanumeric or valid JSON.
JobServiceShowOutput, JobServiceShowOutputArgs
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Compute
Pool string - Created
On string - Current
Instances int - Database
Name string - Dns
Name string - External
Access List<string>Integrations - Is
Async boolJob - Is
Job bool - Is
Upgrading bool - Managing
Object stringDomain - Managing
Object stringName - Max
Instances int - Min
Instances int - Min
Ready intInstances - Name string
- Owner string
- Owner
Role stringType - Query
Warehouse string - Resumed
On string - Schema
Name string - Spec
Digest string - Status string
- Suspended
On string - Target
Instances int - Updated
On string
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Compute
Pool string - Created
On string - Current
Instances int - Database
Name string - Dns
Name string - External
Access []stringIntegrations - Is
Async boolJob - Is
Job bool - Is
Upgrading bool - Managing
Object stringDomain - Managing
Object stringName - Max
Instances int - Min
Instances int - Min
Ready intInstances - Name string
- Owner string
- Owner
Role stringType - Query
Warehouse string - Resumed
On string - Schema
Name string - Spec
Digest string - Status string
- Suspended
On string - Target
Instances int - Updated
On string
- auto
Resume Boolean - auto
Suspend IntegerSecs - comment String
- compute
Pool String - created
On String - current
Instances Integer - database
Name String - dns
Name String - external
Access List<String>Integrations - is
Async BooleanJob - is
Job Boolean - is
Upgrading Boolean - managing
Object StringDomain - managing
Object StringName - max
Instances Integer - min
Instances Integer - min
Ready IntegerInstances - name String
- owner String
- owner
Role StringType - query
Warehouse String - resumed
On String - schema
Name String - spec
Digest String - status String
- suspended
On String - target
Instances Integer - updated
On String
- auto
Resume boolean - auto
Suspend numberSecs - comment string
- compute
Pool string - created
On string - current
Instances number - database
Name string - dns
Name string - external
Access string[]Integrations - is
Async booleanJob - is
Job boolean - is
Upgrading boolean - managing
Object stringDomain - managing
Object stringName - max
Instances number - min
Instances number - min
Ready numberInstances - name string
- owner string
- owner
Role stringType - query
Warehouse string - resumed
On string - schema
Name string - spec
Digest string - status string
- suspended
On string - target
Instances number - updated
On string
- auto_
resume bool - auto_
suspend_ intsecs - comment str
- compute_
pool str - created_
on str - current_
instances int - database_
name str - dns_
name str - external_
access_ Sequence[str]integrations - is_
async_ booljob - is_
job bool - is_
upgrading bool - managing_
object_ strdomain - managing_
object_ strname - max_
instances int - min_
instances int - min_
ready_ intinstances - name str
- owner str
- owner_
role_ strtype - query_
warehouse str - resumed_
on str - schema_
name str - spec_
digest str - status str
- suspended_
on str - target_
instances int - updated_
on str
- auto
Resume Boolean - auto
Suspend NumberSecs - comment String
- compute
Pool String - created
On String - current
Instances Number - database
Name String - dns
Name String - external
Access List<String>Integrations - is
Async BooleanJob - is
Job Boolean - is
Upgrading Boolean - managing
Object StringDomain - managing
Object StringName - max
Instances Number - min
Instances Number - min
Ready NumberInstances - name String
- owner String
- owner
Role StringType - query
Warehouse String - resumed
On String - schema
Name String - spec
Digest String - status String
- suspended
On String - target
Instances Number - updated
On String
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflake
Terraform Provider.