1. Packages
  2. Snowflake Provider
  3. API Docs
  4. Stage
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.Stage

snowflake logo
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

    !> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

    Note Starting from the [Bundle 2025_05](https://docs.snowflake.com/en/release-notes/bcr-bundles/2025_05/bcr-1989), a stage cannot be dropped successfully if it has dependent external tables. Before dropping the resource, first drop the dependent external tables manually.

    Deprecation This resource is deprecated and will be removed in a future major version release. Please use one of the new resources instead: snowflake.StageInternal | snowflake.StageExternalS3 | snowflake.StageExternalS3Compatible | snowflake.StageExternalGcs | snowflake.StageExternalAzure.

    Example Usage

    Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

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

const config = new pulumi.Config();
const exampleAwsKeyId = config.require("exampleAwsKeyId");
const exampleAwsSecretKey = config.require("exampleAwsSecretKey");
const exampleStage = new snowflake.Stage("example_stage", {
    name: "EXAMPLE_STAGE",
    url: "s3://com.example.bucket/prefix",
    database: "EXAMPLE_DB",
    schema: "EXAMPLE_SCHEMA",
    credentials: `AWS_KEY_ID='${exampleAwsKeyId}' AWS_SECRET_KEY='${exampleAwsSecretKey}'`,
});
// with an existing hardcoded file format
// please see other examples in the snowflake_file_format resource documentation
const exampleStageWithFileFormat = new snowflake.Stage("example_stage_with_file_format", {
    name: "EXAMPLE_STAGE",
    url: "s3://com.example.bucket/prefix",
    database: "EXAMPLE_DB",
    schema: "EXAMPLE_SCHEMA",
    credentials: `AWS_KEY_ID='${exampleAwsKeyId}' AWS_SECRET_KEY='${exampleAwsSecretKey}'`,
    fileFormat: "FORMAT_NAME = DB.SCHEMA.FORMATNAME",
});

    import pulumi
import pulumi_snowflake as snowflake

config = pulumi.Config()
example_aws_key_id = config.require("exampleAwsKeyId")
example_aws_secret_key = config.require("exampleAwsSecretKey")
example_stage = snowflake.Stage("example_stage",
    name="EXAMPLE_STAGE",
    url="s3://com.example.bucket/prefix",
    database="EXAMPLE_DB",
    schema="EXAMPLE_SCHEMA",
    credentials=f"AWS_KEY_ID='{example_aws_key_id}' AWS_SECRET_KEY='{example_aws_secret_key}'")
# with an existing hardcoded file format
# please see other examples in the snowflake_file_format resource documentation
example_stage_with_file_format = snowflake.Stage("example_stage_with_file_format",
    name="EXAMPLE_STAGE",
    url="s3://com.example.bucket/prefix",
    database="EXAMPLE_DB",
    schema="EXAMPLE_SCHEMA",
    credentials=f"AWS_KEY_ID='{example_aws_key_id}' AWS_SECRET_KEY='{example_aws_secret_key}'",
    file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME")

    package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		exampleAwsKeyId := cfg.Require("exampleAwsKeyId")
		exampleAwsSecretKey := cfg.Require("exampleAwsSecretKey")
		_, err := snowflake.NewStage(ctx, "example_stage", &snowflake.StageArgs{
			Name:        pulumi.String("EXAMPLE_STAGE"),
			Url:         pulumi.String("s3://com.example.bucket/prefix"),
			Database:    pulumi.String("EXAMPLE_DB"),
			Schema:      pulumi.String("EXAMPLE_SCHEMA"),
			Credentials: pulumi.Sprintf("AWS_KEY_ID='%v' AWS_SECRET_KEY='%v'", exampleAwsKeyId, exampleAwsSecretKey),
		})
		if err != nil {
			return err
		}
		// with an existing hardcoded file format
		// please see other examples in the snowflake_file_format resource documentation
		_, err = snowflake.NewStage(ctx, "example_stage_with_file_format", &snowflake.StageArgs{
			Name:        pulumi.String("EXAMPLE_STAGE"),
			Url:         pulumi.String("s3://com.example.bucket/prefix"),
			Database:    pulumi.String("EXAMPLE_DB"),
			Schema:      pulumi.String("EXAMPLE_SCHEMA"),
			Credentials: pulumi.Sprintf("AWS_KEY_ID='%v' AWS_SECRET_KEY='%v'", exampleAwsKeyId, exampleAwsSecretKey),
			FileFormat:  pulumi.String("FORMAT_NAME = DB.SCHEMA.FORMATNAME"),
		})
		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 config = new Config();
    var exampleAwsKeyId = config.Require("exampleAwsKeyId");
    var exampleAwsSecretKey = config.Require("exampleAwsSecretKey");
    var exampleStage = new Snowflake.Stage("example_stage", new()
    {
        Name = "EXAMPLE_STAGE",
        Url = "s3://com.example.bucket/prefix",
        Database = "EXAMPLE_DB",
        Schema = "EXAMPLE_SCHEMA",
        Credentials = $"AWS_KEY_ID='{exampleAwsKeyId}' AWS_SECRET_KEY='{exampleAwsSecretKey}'",
    });

    // with an existing hardcoded file format
    // please see other examples in the snowflake_file_format resource documentation
    var exampleStageWithFileFormat = new Snowflake.Stage("example_stage_with_file_format", new()
    {
        Name = "EXAMPLE_STAGE",
        Url = "s3://com.example.bucket/prefix",
        Database = "EXAMPLE_DB",
        Schema = "EXAMPLE_SCHEMA",
        Credentials = $"AWS_KEY_ID='{exampleAwsKeyId}' AWS_SECRET_KEY='{exampleAwsSecretKey}'",
        FileFormat = "FORMAT_NAME = DB.SCHEMA.FORMATNAME",
    });

});

    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) {
        final var config = ctx.config();
        final var exampleAwsKeyId = config.get("exampleAwsKeyId");
        final var exampleAwsSecretKey = config.get("exampleAwsSecretKey");
        var exampleStage = new Stage("exampleStage", StageArgs.builder()
            .name("EXAMPLE_STAGE")
            .url("s3://com.example.bucket/prefix")
            .database("EXAMPLE_DB")
            .schema("EXAMPLE_SCHEMA")
            .credentials(String.format("AWS_KEY_ID='%s' AWS_SECRET_KEY='%s'", exampleAwsKeyId,exampleAwsSecretKey))
            .build());

        // with an existing hardcoded file format
        // please see other examples in the snowflake_file_format resource documentation
        var exampleStageWithFileFormat = new Stage("exampleStageWithFileFormat", StageArgs.builder()
            .name("EXAMPLE_STAGE")
            .url("s3://com.example.bucket/prefix")
            .database("EXAMPLE_DB")
            .schema("EXAMPLE_SCHEMA")
            .credentials(String.format("AWS_KEY_ID='%s' AWS_SECRET_KEY='%s'", exampleAwsKeyId,exampleAwsSecretKey))
            .fileFormat("FORMAT_NAME = DB.SCHEMA.FORMATNAME")
            .build());

    }
}

    configuration:
  exampleAwsKeyId:
    type: string
  exampleAwsSecretKey:
    type: string
resources:
  exampleStage:
    type: snowflake:Stage
    name: example_stage
    properties:
      name: EXAMPLE_STAGE
      url: s3://com.example.bucket/prefix
      database: EXAMPLE_DB
      schema: EXAMPLE_SCHEMA
      credentials: AWS_KEY_ID='${exampleAwsKeyId}' AWS_SECRET_KEY='${exampleAwsSecretKey}'
  # with an existing hardcoded file format
  # please see other examples in the snowflake_file_format resource documentation
  exampleStageWithFileFormat:
    type: snowflake:Stage
    name: example_stage_with_file_format
    properties:
      name: EXAMPLE_STAGE
      url: s3://com.example.bucket/prefix
      database: EXAMPLE_DB
      schema: EXAMPLE_SCHEMA
      credentials: AWS_KEY_ID='${exampleAwsKeyId}' AWS_SECRET_KEY='${exampleAwsSecretKey}'
      fileFormat: FORMAT_NAME = DB.SCHEMA.FORMATNAME

    Note If a field has a default value, it is shown next to the type in the schema.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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)
    resources:  _:    type: snowflake:Stage    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.
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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. Specifying the default Snowflake value (e.g. TYPE = CSV) will currently result in a permadiff (check #2679). For now, omit the default values; it will be fixed in the upcoming provider versions. Examples of usage: \n\n1. with hardcoding value:\n\n file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME" \n\n2. from dynamic value:\n\n file_format </span>= "FORMAT_NAME = ${snowflake_file_format.myfileformat.fully_qualified_name}" \n\n3. from expression:\n\n file_format </span>= format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name). Reference: #265
    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.

    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
    Viewing docs for Snowflake v2.13.0
    published on Thursday, Feb 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake
      Try Pulumi Cloud free. Your team will thank you.