Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake
  3. API Docs
  4. Stage
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.Stage

Explore with Pulumi AI

snowflake logo
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    format is database name | schema name | stage name

    $ pulumi import snowflake:index/stage:Stage example 'dbName|schemaName|stageName'

    Create Stage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Stage(name: string, args: StageArgs, opts?: CustomResourceOptions);
    @overload
def Stage(resource_name: str,
          args: StageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Stage(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          database: Optional[str] = None,
          schema: Optional[str] = None,
          credentials: Optional[str] = None,
          aws_external_id: Optional[str] = None,
          copy_options: Optional[str] = None,
          directory: Optional[str] = None,
          encryption: Optional[str] = None,
          file_format: Optional[str] = None,
          name: Optional[str] = None,
          comment: Optional[str] = None,
          snowflake_iam_user: Optional[str] = None,
          storage_integration: Optional[str] = None,
          tags: Optional[Sequence[StageTagArgs]] = None,
          url: Optional[str] = None)
    func NewStage(ctx *Context, name string, args StageArgs, opts ...ResourceOption) (*Stage, error)
    public Stage(string name, StageArgs args, CustomResourceOptions? opts = null)
    public Stage(String name, StageArgs args)
public Stage(String name, StageArgs args, CustomResourceOptions options)

    type: snowflake:Stage
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 StageArgs
    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 StageArgs
    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 StageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StageArgs
    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 stageResource = new Snowflake.Stage("stageResource", new()
{
    Database = "string",
    Schema = "string",
    Credentials = "string",
    AwsExternalId = "string",
    CopyOptions = "string",
    Directory = "string",
    Encryption = "string",
    FileFormat = "string",
    Name = "string",
    Comment = "string",
    SnowflakeIamUser = "string",
    StorageIntegration = "string",
    Url = "string",
});

    example, err := snowflake.NewStage(ctx, "stageResource", &snowflake.StageArgs{
	Database:           pulumi.String("string"),
	Schema:             pulumi.String("string"),
	Credentials:        pulumi.String("string"),
	AwsExternalId:      pulumi.String("string"),
	CopyOptions:        pulumi.String("string"),
	Directory:          pulumi.String("string"),
	Encryption:         pulumi.String("string"),
	FileFormat:         pulumi.String("string"),
	Name:               pulumi.String("string"),
	Comment:            pulumi.String("string"),
	SnowflakeIamUser:   pulumi.String("string"),
	StorageIntegration: pulumi.String("string"),
	Url:                pulumi.String("string"),
})

    var stageResource = new Stage("stageResource", StageArgs.builder()
    .database("string")
    .schema("string")
    .credentials("string")
    .awsExternalId("string")
    .copyOptions("string")
    .directory("string")
    .encryption("string")
    .fileFormat("string")
    .name("string")
    .comment("string")
    .snowflakeIamUser("string")
    .storageIntegration("string")
    .url("string")
    .build());

    stage_resource = snowflake.Stage("stageResource",
    database="string",
    schema="string",
    credentials="string",
    aws_external_id="string",
    copy_options="string",
    directory="string",
    encryption="string",
    file_format="string",
    name="string",
    comment="string",
    snowflake_iam_user="string",
    storage_integration="string",
    url="string")

    const stageResource = new snowflake.Stage("stageResource", {
    database: "string",
    schema: "string",
    credentials: "string",
    awsExternalId: "string",
    copyOptions: "string",
    directory: "string",
    encryption: "string",
    fileFormat: "string",
    name: "string",
    comment: "string",
    snowflakeIamUser: "string",
    storageIntegration: "string",
    url: "string",
});

    type: snowflake:Stage
properties:
    awsExternalId: string
    comment: string
    copyOptions: string
    credentials: string
    database: string
    directory: string
    encryption: string
    fileFormat: string
    name: string
    schema: string
    snowflakeIamUser: string
    storageIntegration: string
    url: string

    Stage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Stage resource accepts the following input properties:

    Database string
    The database in which to create the stage.
    Schema string
    The schema in which to create the stage.
    AwsExternalId string
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    Comment string
    Specifies a comment for the stage.
    CopyOptions string
    Specifies the copy options for the stage.
    Credentials string
    Specifies the credentials for the stage.
    Directory string
    Specifies the directory settings for the stage.
    Encryption string
    Specifies the encryption settings for the stage.
    FileFormat string
    Specifies the file format for the stage.
    Name string
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    SnowflakeIamUser string
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    StorageIntegration string
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    Tags List<StageTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Url string
    Specifies the URL for the stage.
    Database string
    The database in which to create the stage.
    Schema string
    The schema in which to create the stage.
    AwsExternalId string
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    Comment string
    Specifies a comment for the stage.
    CopyOptions string
    Specifies the copy options for the stage.
    Credentials string
    Specifies the credentials for the stage.
    Directory string
    Specifies the directory settings for the stage.
    Encryption string
    Specifies the encryption settings for the stage.
    FileFormat string
    Specifies the file format for the stage.
    Name string
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    SnowflakeIamUser string
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    StorageIntegration string
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    Tags []StageTagArgs
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Url string
    Specifies the URL for the stage.
    database String
    The database in which to create the stage.
    schema String
    The schema in which to create the stage.
    awsExternalId String
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment String
    Specifies a comment for the stage.
    copyOptions String
    Specifies the copy options for the stage.
    credentials String
    Specifies the credentials for the stage.
    directory String
    Specifies the directory settings for the stage.
    encryption String
    Specifies the encryption settings for the stage.
    fileFormat String
    Specifies the file format for the stage.
    name String
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    snowflakeIamUser String
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storageIntegration String
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags List<StageTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url String
    Specifies the URL for the stage.
    database string
    The database in which to create the stage.
    schema string
    The schema in which to create the stage.
    awsExternalId string
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment string
    Specifies a comment for the stage.
    copyOptions string
    Specifies the copy options for the stage.
    credentials string
    Specifies the credentials for the stage.
    directory string
    Specifies the directory settings for the stage.
    encryption string
    Specifies the encryption settings for the stage.
    fileFormat string
    Specifies the file format for the stage.
    name string
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    snowflakeIamUser string
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storageIntegration string
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags StageTag[]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url string
    Specifies the URL for the stage.
    database str
    The database in which to create the stage.
    schema str
    The schema in which to create the stage.
    aws_external_id str
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment str
    Specifies a comment for the stage.
    copy_options str
    Specifies the copy options for the stage.
    credentials str
    Specifies the credentials for the stage.
    directory str
    Specifies the directory settings for the stage.
    encryption str
    Specifies the encryption settings for the stage.
    file_format str
    Specifies the file format for the stage.
    name str
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    snowflake_iam_user str
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storage_integration str
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags Sequence[StageTagArgs]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url str
    Specifies the URL for the stage.
    database String
    The database in which to create the stage.
    schema String
    The schema in which to create the stage.
    awsExternalId String
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment String
    Specifies a comment for the stage.
    copyOptions String
    Specifies the copy options for the stage.
    credentials String
    Specifies the credentials for the stage.
    directory String
    Specifies the directory settings for the stage.
    encryption String
    Specifies the encryption settings for the stage.
    fileFormat String
    Specifies the file format for the stage.
    name String
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    snowflakeIamUser String
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storageIntegration String
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags List<Property Map>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url String
    Specifies the URL for the stage.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Stage resource produces the following output properties:

    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Stage Resource

    Get an existing Stage 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?: StageState, opts?: CustomResourceOptions): Stage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_external_id: Optional[str] = None,
        comment: Optional[str] = None,
        copy_options: Optional[str] = None,
        credentials: Optional[str] = None,
        database: Optional[str] = None,
        directory: Optional[str] = None,
        encryption: Optional[str] = None,
        file_format: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        snowflake_iam_user: Optional[str] = None,
        storage_integration: Optional[str] = None,
        tags: Optional[Sequence[StageTagArgs]] = None,
        url: Optional[str] = None) -> Stage
    func GetStage(ctx *Context, name string, id IDInput, state *StageState, opts ...ResourceOption) (*Stage, error)
    public static Stage Get(string name, Input<string> id, StageState? state, CustomResourceOptions? opts = null)
    public static Stage get(String name, Output<String> id, StageState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    AwsExternalId string
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    Comment string
    Specifies a comment for the stage.
    CopyOptions string
    Specifies the copy options for the stage.
    Credentials string
    Specifies the credentials for the stage.
    Database string
    The database in which to create the stage.
    Directory string
    Specifies the directory settings for the stage.
    Encryption string
    Specifies the encryption settings for the stage.
    FileFormat string
    Specifies the file format for the stage.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    Schema string
    The schema in which to create the stage.
    SnowflakeIamUser string
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    StorageIntegration string
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    Tags List<StageTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Url string
    Specifies the URL for the stage.
    AwsExternalId string
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    Comment string
    Specifies a comment for the stage.
    CopyOptions string
    Specifies the copy options for the stage.
    Credentials string
    Specifies the credentials for the stage.
    Database string
    The database in which to create the stage.
    Directory string
    Specifies the directory settings for the stage.
    Encryption string
    Specifies the encryption settings for the stage.
    FileFormat string
    Specifies the file format for the stage.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    Schema string
    The schema in which to create the stage.
    SnowflakeIamUser string
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    StorageIntegration string
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    Tags []StageTagArgs
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    Url string
    Specifies the URL for the stage.
    awsExternalId String
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment String
    Specifies a comment for the stage.
    copyOptions String
    Specifies the copy options for the stage.
    credentials String
    Specifies the credentials for the stage.
    database String
    The database in which to create the stage.
    directory String
    Specifies the directory settings for the stage.
    encryption String
    Specifies the encryption settings for the stage.
    fileFormat String
    Specifies the file format for the stage.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    schema String
    The schema in which to create the stage.
    snowflakeIamUser String
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storageIntegration String
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags List<StageTag>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url String
    Specifies the URL for the stage.
    awsExternalId string
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment string
    Specifies a comment for the stage.
    copyOptions string
    Specifies the copy options for the stage.
    credentials string
    Specifies the credentials for the stage.
    database string
    The database in which to create the stage.
    directory string
    Specifies the directory settings for the stage.
    encryption string
    Specifies the encryption settings for the stage.
    fileFormat string
    Specifies the file format for the stage.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    schema string
    The schema in which to create the stage.
    snowflakeIamUser string
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storageIntegration string
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags StageTag[]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url string
    Specifies the URL for the stage.
    aws_external_id str
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment str
    Specifies a comment for the stage.
    copy_options str
    Specifies the copy options for the stage.
    credentials str
    Specifies the credentials for the stage.
    database str
    The database in which to create the stage.
    directory str
    Specifies the directory settings for the stage.
    encryption str
    Specifies the encryption settings for the stage.
    file_format str
    Specifies the file format for the stage.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    schema str
    The schema in which to create the stage.
    snowflake_iam_user str
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storage_integration str
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags Sequence[StageTagArgs]
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url str
    Specifies the URL for the stage.
    awsExternalId String
    A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
    comment String
    Specifies a comment for the stage.
    copyOptions String
    Specifies the copy options for the stage.
    credentials String
    Specifies the credentials for the stage.
    database String
    The database in which to create the stage.
    directory String
    Specifies the directory settings for the stage.
    encryption String
    Specifies the encryption settings for the stage.
    fileFormat String
    Specifies the file format for the stage.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created.
    schema String
    The schema in which to create the stage.
    snowflakeIamUser String
    An AWS IAM user created for your Snowflake account. This user is the same for every external S3 stage created in your account.
    storageIntegration String
    Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
    tags List<Property Map>
    Definitions of a tag to associate with the resource.

    Deprecated: Use the 'snowflake_tag_association' resource instead.

    url String
    Specifies the URL for the stage.

    Supporting Types

    StageTag, StageTagArgs

    Name string
    Tag name, e.g. department.
    Value string
    Tag value, e.g. marketing_info.
    Database string
    Name of the database that the tag was created in.
    Schema string
    Name of the schema that the tag was created in.
    Name string
    Tag name, e.g. department.
    Value string
    Tag value, e.g. marketing_info.
    Database string
    Name of the database that the tag was created in.
    Schema string
    Name of the schema that the tag was created in.
    name String
    Tag name, e.g. department.
    value String
    Tag value, e.g. marketing_info.
    database String
    Name of the database that the tag was created in.
    schema String
    Name of the schema that the tag was created in.
    name string
    Tag name, e.g. department.
    value string
    Tag value, e.g. marketing_info.
    database string
    Name of the database that the tag was created in.
    schema string
    Name of the schema that the tag was created in.
    name str
    Tag name, e.g. department.
    value str
    Tag value, e.g. marketing_info.
    database str
    Name of the database that the tag was created in.
    schema str
    Name of the schema that the tag was created in.
    name String
    Tag name, e.g. department.
    value String
    Tag value, e.g. marketing_info.
    database String
    Name of the database that the tag was created in.
    schema String
    Name of the schema that the tag was created in.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
    pulumi/pulumi-snowflake