Docs Packages
  1. Packages
  2. Snowflake
  3. API Docs
  4. Stage
Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.Stage

Explore with Pulumi AI

snowflake logo
Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi
pulumi/pulumi-snowflake

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const exampleStage = new snowflake.Stage("exampleStage", {
    credentials: `AWS_KEY_ID='${_var.example_aws_key_id}' AWS_SECRET_KEY='${_var.example_aws_secret_key}'`,
    database: "EXAMPLE_DB",
    schema: "EXAMPLE_SCHEMA",
    url: "s3://com.example.bucket/prefix",
});

    import pulumi
import pulumi_snowflake as snowflake

example_stage = snowflake.Stage("exampleStage",
    credentials=f"AWS_KEY_ID='{var['example_aws_key_id']}' AWS_SECRET_KEY='{var['example_aws_secret_key']}'",
    database="EXAMPLE_DB",
    schema="EXAMPLE_SCHEMA",
    url="s3://com.example.bucket/prefix")

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := snowflake.NewStage(ctx, "exampleStage", &snowflake.StageArgs{
			Credentials: pulumi.String(fmt.Sprintf("AWS_KEY_ID='%v' AWS_SECRET_KEY='%v'", _var.Example_aws_key_id, _var.Example_aws_secret_key)),
			Database:    pulumi.String("EXAMPLE_DB"),
			Schema:      pulumi.String("EXAMPLE_SCHEMA"),
			Url:         pulumi.String("s3://com.example.bucket/prefix"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    var exampleStage = new Snowflake.Stage("exampleStage", new()
    {
        Credentials = $"AWS_KEY_ID='{@var.Example_aws_key_id}' AWS_SECRET_KEY='{@var.Example_aws_secret_key}'",
        Database = "EXAMPLE_DB",
        Schema = "EXAMPLE_SCHEMA",
        Url = "s3://com.example.bucket/prefix",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.Stage;
import com.pulumi.snowflake.StageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleStage = new Stage("exampleStage", StageArgs.builder()        
            .credentials(String.format("AWS_KEY_ID='%s' AWS_SECRET_KEY='%s'", var_.example_aws_key_id(),var_.example_aws_secret_key()))
            .database("EXAMPLE_DB")
            .schema("EXAMPLE_SCHEMA")
            .url("s3://com.example.bucket/prefix")
            .build());

    }
}

    resources:
  exampleStage:
    type: snowflake:Stage
    properties:
      credentials: AWS_KEY_ID='${var.example_aws_key_id}' AWS_SECRET_KEY='${var.example_aws_secret_key}'
      database: EXAMPLE_DB
      schema: EXAMPLE_SCHEMA
      url: s3://com.example.bucket/prefix

    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.

    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
    Name of the database that the tag was created in.
    Schema string
    Name of the schema that the tag was created in.
    AwsExternalId string
    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
    Tag name, e.g. department.
    SnowflakeIamUser string
    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
    Name of the database that the tag was created in.
    Schema string
    Name of the schema that the tag was created in.
    AwsExternalId string
    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
    Tag name, e.g. department.
    SnowflakeIamUser string
    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
    Name of the database that the tag was created in.
    schema String
    Name of the schema that the tag was created in.
    awsExternalId String
    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
    Tag name, e.g. department.
    snowflakeIamUser String
    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
    Name of the database that the tag was created in.
    schema string
    Name of the schema that the tag was created in.
    awsExternalId string
    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
    Tag name, e.g. department.
    snowflakeIamUser string
    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
    Name of the database that the tag was created in.
    schema str
    Name of the schema that the tag was created in.
    aws_external_id str
    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
    Tag name, e.g. department.
    snowflake_iam_user str
    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
    Name of the database that the tag was created in.
    schema String
    Name of the schema that the tag was created in.
    awsExternalId String
    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
    Tag name, e.g. department.
    snowflakeIamUser String
    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:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    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,
        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
    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
    Name of the database that the tag was created in.
    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
    Tag name, e.g. department.
    Schema string
    Name of the schema that the tag was created in.
    SnowflakeIamUser string
    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
    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
    Name of the database that the tag was created in.
    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
    Tag name, e.g. department.
    Schema string
    Name of the schema that the tag was created in.
    SnowflakeIamUser string
    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
    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
    Name of the database that the tag was created in.
    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
    Tag name, e.g. department.
    schema String
    Name of the schema that the tag was created in.
    snowflakeIamUser String
    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
    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
    Name of the database that the tag was created in.
    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
    Tag name, e.g. department.
    schema string
    Name of the schema that the tag was created in.
    snowflakeIamUser string
    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
    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
    Name of the database that the tag was created in.
    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
    Tag name, e.g. department.
    schema str
    Name of the schema that the tag was created in.
    snowflake_iam_user str
    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
    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
    Name of the database that the tag was created in.
    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
    Tag name, e.g. department.
    schema String
    Name of the schema that the tag was created in.
    snowflakeIamUser String
    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.

    Import

    format is database name | schema name | stage name

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

    To learn more about importing existing cloud resources, see Importing resources.

    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.51.0 published on Wednesday, Apr 10, 2024 by Pulumi
    pulumi/pulumi-snowflake