Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. ExternalTable
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.ExternalTable

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

format is database name | schema name | external table name

$ pulumi import snowflake:index/externalTable:ExternalTable example 'dbName|schemaName|externalTableName'
Copy

Create ExternalTable Resource

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

Constructor syntax

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

@overload
def ExternalTable(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  database: Optional[str] = None,
                  schema: Optional[str] = None,
                  columns: Optional[Sequence[ExternalTableColumnArgs]] = None,
                  location: Optional[str] = None,
                  file_format: Optional[str] = None,
                  comment: Optional[str] = None,
                  copy_grants: Optional[bool] = None,
                  auto_refresh: Optional[bool] = None,
                  name: Optional[str] = None,
                  partition_bies: Optional[Sequence[str]] = None,
                  pattern: Optional[str] = None,
                  refresh_on_create: Optional[bool] = None,
                  aws_sns_topic: Optional[str] = None,
                  table_format: Optional[str] = None,
                  tags: Optional[Sequence[ExternalTableTagArgs]] = None)
func NewExternalTable(ctx *Context, name string, args ExternalTableArgs, opts ...ResourceOption) (*ExternalTable, error)
public ExternalTable(string name, ExternalTableArgs args, CustomResourceOptions? opts = null)
public ExternalTable(String name, ExternalTableArgs args)
public ExternalTable(String name, ExternalTableArgs args, CustomResourceOptions options)

type: snowflake:ExternalTable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ExternalTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ExternalTableArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ExternalTableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ExternalTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ExternalTableArgs
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 externalTableResource = new Snowflake.ExternalTable("externalTableResource", new()
{
    Database = "string",
    Schema = "string",
    Columns = new[]
    {
        new Snowflake.Inputs.ExternalTableColumnArgs
        {
            As = "string",
            Name = "string",
            Type = "string",
        },
    },
    Location = "string",
    FileFormat = "string",
    Comment = "string",
    CopyGrants = false,
    AutoRefresh = false,
    Name = "string",
    PartitionBies = new[]
    {
        "string",
    },
    Pattern = "string",
    RefreshOnCreate = false,
    AwsSnsTopic = "string",
    TableFormat = "string",
});
Copy
example, err := snowflake.NewExternalTable(ctx, "externalTableResource", &snowflake.ExternalTableArgs{
	Database: pulumi.String("string"),
	Schema:   pulumi.String("string"),
	Columns: snowflake.ExternalTableColumnArray{
		&snowflake.ExternalTableColumnArgs{
			As:   pulumi.String("string"),
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	Location:    pulumi.String("string"),
	FileFormat:  pulumi.String("string"),
	Comment:     pulumi.String("string"),
	CopyGrants:  pulumi.Bool(false),
	AutoRefresh: pulumi.Bool(false),
	Name:        pulumi.String("string"),
	PartitionBies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Pattern:         pulumi.String("string"),
	RefreshOnCreate: pulumi.Bool(false),
	AwsSnsTopic:     pulumi.String("string"),
	TableFormat:     pulumi.String("string"),
})
Copy
var externalTableResource = new ExternalTable("externalTableResource", ExternalTableArgs.builder()
    .database("string")
    .schema("string")
    .columns(ExternalTableColumnArgs.builder()
        .as("string")
        .name("string")
        .type("string")
        .build())
    .location("string")
    .fileFormat("string")
    .comment("string")
    .copyGrants(false)
    .autoRefresh(false)
    .name("string")
    .partitionBies("string")
    .pattern("string")
    .refreshOnCreate(false)
    .awsSnsTopic("string")
    .tableFormat("string")
    .build());
Copy
external_table_resource = snowflake.ExternalTable("externalTableResource",
    database="string",
    schema="string",
    columns=[{
        "as_": "string",
        "name": "string",
        "type": "string",
    }],
    location="string",
    file_format="string",
    comment="string",
    copy_grants=False,
    auto_refresh=False,
    name="string",
    partition_bies=["string"],
    pattern="string",
    refresh_on_create=False,
    aws_sns_topic="string",
    table_format="string")
Copy
const externalTableResource = new snowflake.ExternalTable("externalTableResource", {
    database: "string",
    schema: "string",
    columns: [{
        as: "string",
        name: "string",
        type: "string",
    }],
    location: "string",
    fileFormat: "string",
    comment: "string",
    copyGrants: false,
    autoRefresh: false,
    name: "string",
    partitionBies: ["string"],
    pattern: "string",
    refreshOnCreate: false,
    awsSnsTopic: "string",
    tableFormat: "string",
});
Copy
type: snowflake:ExternalTable
properties:
    autoRefresh: false
    awsSnsTopic: string
    columns:
        - as: string
          name: string
          type: string
    comment: string
    copyGrants: false
    database: string
    fileFormat: string
    location: string
    name: string
    partitionBies:
        - string
    pattern: string
    refreshOnCreate: false
    schema: string
    tableFormat: string
Copy

ExternalTable 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 ExternalTable resource accepts the following input properties:

Columns
This property is required.
Changes to this property will trigger replacement.
List<ExternalTableColumn>
Definitions of a column to create in the external table. Minimum one required.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the external table.
FileFormat
This property is required.
Changes to this property will trigger replacement.
string
Specifies the file format for the external table.
Location
This property is required.
Changes to this property will trigger replacement.
string
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the external table.
AutoRefresh Changes to this property will trigger replacement. bool
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
AwsSnsTopic Changes to this property will trigger replacement. string
Specifies the aws sns topic for the external table.
Comment Changes to this property will trigger replacement. string
Specifies a comment for the external table.
CopyGrants Changes to this property will trigger replacement. bool
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
Name Changes to this property will trigger replacement. string
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
PartitionBies Changes to this property will trigger replacement. List<string>
Specifies any partition columns to evaluate for the external table.
Pattern Changes to this property will trigger replacement. string
Specifies the file names and/or paths on the external stage to match.
RefreshOnCreate Changes to this property will trigger replacement. bool
Specifies weather to refresh when an external table is created.
TableFormat Changes to this property will trigger replacement. string
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
Tags List<ExternalTableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

Columns
This property is required.
Changes to this property will trigger replacement.
[]ExternalTableColumnArgs
Definitions of a column to create in the external table. Minimum one required.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the external table.
FileFormat
This property is required.
Changes to this property will trigger replacement.
string
Specifies the file format for the external table.
Location
This property is required.
Changes to this property will trigger replacement.
string
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the external table.
AutoRefresh Changes to this property will trigger replacement. bool
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
AwsSnsTopic Changes to this property will trigger replacement. string
Specifies the aws sns topic for the external table.
Comment Changes to this property will trigger replacement. string
Specifies a comment for the external table.
CopyGrants Changes to this property will trigger replacement. bool
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
Name Changes to this property will trigger replacement. string
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
PartitionBies Changes to this property will trigger replacement. []string
Specifies any partition columns to evaluate for the external table.
Pattern Changes to this property will trigger replacement. string
Specifies the file names and/or paths on the external stage to match.
RefreshOnCreate Changes to this property will trigger replacement. bool
Specifies weather to refresh when an external table is created.
TableFormat Changes to this property will trigger replacement. string
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
Tags []ExternalTableTagArgs
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns
This property is required.
Changes to this property will trigger replacement.
List<ExternalTableColumn>
Definitions of a column to create in the external table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the external table.
fileFormat
This property is required.
Changes to this property will trigger replacement.
String
Specifies the file format for the external table.
location
This property is required.
Changes to this property will trigger replacement.
String
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the external table.
autoRefresh Changes to this property will trigger replacement. Boolean
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
awsSnsTopic Changes to this property will trigger replacement. String
Specifies the aws sns topic for the external table.
comment Changes to this property will trigger replacement. String
Specifies a comment for the external table.
copyGrants Changes to this property will trigger replacement. Boolean
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
name Changes to this property will trigger replacement. String
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
partitionBies Changes to this property will trigger replacement. List<String>
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. String
Specifies the file names and/or paths on the external stage to match.
refreshOnCreate Changes to this property will trigger replacement. Boolean
Specifies weather to refresh when an external table is created.
tableFormat Changes to this property will trigger replacement. String
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags List<ExternalTableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns
This property is required.
Changes to this property will trigger replacement.
ExternalTableColumn[]
Definitions of a column to create in the external table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the external table.
fileFormat
This property is required.
Changes to this property will trigger replacement.
string
Specifies the file format for the external table.
location
This property is required.
Changes to this property will trigger replacement.
string
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the external table.
autoRefresh Changes to this property will trigger replacement. boolean
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
awsSnsTopic Changes to this property will trigger replacement. string
Specifies the aws sns topic for the external table.
comment Changes to this property will trigger replacement. string
Specifies a comment for the external table.
copyGrants Changes to this property will trigger replacement. boolean
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
name Changes to this property will trigger replacement. string
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
partitionBies Changes to this property will trigger replacement. string[]
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. string
Specifies the file names and/or paths on the external stage to match.
refreshOnCreate Changes to this property will trigger replacement. boolean
Specifies weather to refresh when an external table is created.
tableFormat Changes to this property will trigger replacement. string
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags ExternalTableTag[]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns
This property is required.
Changes to this property will trigger replacement.
Sequence[ExternalTableColumnArgs]
Definitions of a column to create in the external table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
str
The database in which to create the external table.
file_format
This property is required.
Changes to this property will trigger replacement.
str
Specifies the file format for the external table.
location
This property is required.
Changes to this property will trigger replacement.
str
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
schema
This property is required.
Changes to this property will trigger replacement.
str
The schema in which to create the external table.
auto_refresh Changes to this property will trigger replacement. bool
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
aws_sns_topic Changes to this property will trigger replacement. str
Specifies the aws sns topic for the external table.
comment Changes to this property will trigger replacement. str
Specifies a comment for the external table.
copy_grants Changes to this property will trigger replacement. bool
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
name Changes to this property will trigger replacement. str
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
partition_bies Changes to this property will trigger replacement. Sequence[str]
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. str
Specifies the file names and/or paths on the external stage to match.
refresh_on_create Changes to this property will trigger replacement. bool
Specifies weather to refresh when an external table is created.
table_format Changes to this property will trigger replacement. str
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags Sequence[ExternalTableTagArgs]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
Definitions of a column to create in the external table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the external table.
fileFormat
This property is required.
Changes to this property will trigger replacement.
String
Specifies the file format for the external table.
location
This property is required.
Changes to this property will trigger replacement.
String
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the external table.
autoRefresh Changes to this property will trigger replacement. Boolean
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
awsSnsTopic Changes to this property will trigger replacement. String
Specifies the aws sns topic for the external table.
comment Changes to this property will trigger replacement. String
Specifies a comment for the external table.
copyGrants Changes to this property will trigger replacement. Boolean
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
name Changes to this property will trigger replacement. String
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
partitionBies Changes to this property will trigger replacement. List<String>
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. String
Specifies the file names and/or paths on the external stage to match.
refreshOnCreate Changes to this property will trigger replacement. Boolean
Specifies weather to refresh when an external table is created.
tableFormat Changes to this property will trigger replacement. String
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags List<Property Map>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

Outputs

All input properties are implicitly available as output properties. Additionally, the ExternalTable 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.
Owner string
Name of the role that owns the external table.
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.
Owner string
Name of the role that owns the external table.
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.
owner String
Name of the role that owns the external table.
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.
owner string
Name of the role that owns the external table.
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.
owner str
Name of the role that owns the external table.
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.
owner String
Name of the role that owns the external table.

Look up Existing ExternalTable Resource

Get an existing ExternalTable 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?: ExternalTableState, opts?: CustomResourceOptions): ExternalTable
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_refresh: Optional[bool] = None,
        aws_sns_topic: Optional[str] = None,
        columns: Optional[Sequence[ExternalTableColumnArgs]] = None,
        comment: Optional[str] = None,
        copy_grants: Optional[bool] = None,
        database: Optional[str] = None,
        file_format: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        partition_bies: Optional[Sequence[str]] = None,
        pattern: Optional[str] = None,
        refresh_on_create: Optional[bool] = None,
        schema: Optional[str] = None,
        table_format: Optional[str] = None,
        tags: Optional[Sequence[ExternalTableTagArgs]] = None) -> ExternalTable
func GetExternalTable(ctx *Context, name string, id IDInput, state *ExternalTableState, opts ...ResourceOption) (*ExternalTable, error)
public static ExternalTable Get(string name, Input<string> id, ExternalTableState? state, CustomResourceOptions? opts = null)
public static ExternalTable get(String name, Output<String> id, ExternalTableState state, CustomResourceOptions options)
resources:  _:    type: snowflake:ExternalTable    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AutoRefresh Changes to this property will trigger replacement. bool
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
AwsSnsTopic Changes to this property will trigger replacement. string
Specifies the aws sns topic for the external table.
Columns Changes to this property will trigger replacement. List<ExternalTableColumn>
Definitions of a column to create in the external table. Minimum one required.
Comment Changes to this property will trigger replacement. string
Specifies a comment for the external table.
CopyGrants Changes to this property will trigger replacement. bool
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
Database Changes to this property will trigger replacement. string
The database in which to create the external table.
FileFormat Changes to this property will trigger replacement. string
Specifies the file format for the external table.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Location Changes to this property will trigger replacement. string
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
Name Changes to this property will trigger replacement. string
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
Owner string
Name of the role that owns the external table.
PartitionBies Changes to this property will trigger replacement. List<string>
Specifies any partition columns to evaluate for the external table.
Pattern Changes to this property will trigger replacement. string
Specifies the file names and/or paths on the external stage to match.
RefreshOnCreate Changes to this property will trigger replacement. bool
Specifies weather to refresh when an external table is created.
Schema Changes to this property will trigger replacement. string
The schema in which to create the external table.
TableFormat Changes to this property will trigger replacement. string
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
Tags List<ExternalTableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

AutoRefresh Changes to this property will trigger replacement. bool
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
AwsSnsTopic Changes to this property will trigger replacement. string
Specifies the aws sns topic for the external table.
Columns Changes to this property will trigger replacement. []ExternalTableColumnArgs
Definitions of a column to create in the external table. Minimum one required.
Comment Changes to this property will trigger replacement. string
Specifies a comment for the external table.
CopyGrants Changes to this property will trigger replacement. bool
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
Database Changes to this property will trigger replacement. string
The database in which to create the external table.
FileFormat Changes to this property will trigger replacement. string
Specifies the file format for the external table.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Location Changes to this property will trigger replacement. string
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
Name Changes to this property will trigger replacement. string
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
Owner string
Name of the role that owns the external table.
PartitionBies Changes to this property will trigger replacement. []string
Specifies any partition columns to evaluate for the external table.
Pattern Changes to this property will trigger replacement. string
Specifies the file names and/or paths on the external stage to match.
RefreshOnCreate Changes to this property will trigger replacement. bool
Specifies weather to refresh when an external table is created.
Schema Changes to this property will trigger replacement. string
The schema in which to create the external table.
TableFormat Changes to this property will trigger replacement. string
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
Tags []ExternalTableTagArgs
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

autoRefresh Changes to this property will trigger replacement. Boolean
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
awsSnsTopic Changes to this property will trigger replacement. String
Specifies the aws sns topic for the external table.
columns Changes to this property will trigger replacement. List<ExternalTableColumn>
Definitions of a column to create in the external table. Minimum one required.
comment Changes to this property will trigger replacement. String
Specifies a comment for the external table.
copyGrants Changes to this property will trigger replacement. Boolean
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
database Changes to this property will trigger replacement. String
The database in which to create the external table.
fileFormat Changes to this property will trigger replacement. String
Specifies the file format for the external table.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
location Changes to this property will trigger replacement. String
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
name Changes to this property will trigger replacement. String
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
owner String
Name of the role that owns the external table.
partitionBies Changes to this property will trigger replacement. List<String>
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. String
Specifies the file names and/or paths on the external stage to match.
refreshOnCreate Changes to this property will trigger replacement. Boolean
Specifies weather to refresh when an external table is created.
schema Changes to this property will trigger replacement. String
The schema in which to create the external table.
tableFormat Changes to this property will trigger replacement. String
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags List<ExternalTableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

autoRefresh Changes to this property will trigger replacement. boolean
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
awsSnsTopic Changes to this property will trigger replacement. string
Specifies the aws sns topic for the external table.
columns Changes to this property will trigger replacement. ExternalTableColumn[]
Definitions of a column to create in the external table. Minimum one required.
comment Changes to this property will trigger replacement. string
Specifies a comment for the external table.
copyGrants Changes to this property will trigger replacement. boolean
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
database Changes to this property will trigger replacement. string
The database in which to create the external table.
fileFormat Changes to this property will trigger replacement. string
Specifies the file format for the external table.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
location Changes to this property will trigger replacement. string
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
name Changes to this property will trigger replacement. string
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
owner string
Name of the role that owns the external table.
partitionBies Changes to this property will trigger replacement. string[]
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. string
Specifies the file names and/or paths on the external stage to match.
refreshOnCreate Changes to this property will trigger replacement. boolean
Specifies weather to refresh when an external table is created.
schema Changes to this property will trigger replacement. string
The schema in which to create the external table.
tableFormat Changes to this property will trigger replacement. string
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags ExternalTableTag[]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

auto_refresh Changes to this property will trigger replacement. bool
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
aws_sns_topic Changes to this property will trigger replacement. str
Specifies the aws sns topic for the external table.
columns Changes to this property will trigger replacement. Sequence[ExternalTableColumnArgs]
Definitions of a column to create in the external table. Minimum one required.
comment Changes to this property will trigger replacement. str
Specifies a comment for the external table.
copy_grants Changes to this property will trigger replacement. bool
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
database Changes to this property will trigger replacement. str
The database in which to create the external table.
file_format Changes to this property will trigger replacement. str
Specifies the file format for the external table.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
location Changes to this property will trigger replacement. str
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
name Changes to this property will trigger replacement. str
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
owner str
Name of the role that owns the external table.
partition_bies Changes to this property will trigger replacement. Sequence[str]
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. str
Specifies the file names and/or paths on the external stage to match.
refresh_on_create Changes to this property will trigger replacement. bool
Specifies weather to refresh when an external table is created.
schema Changes to this property will trigger replacement. str
The schema in which to create the external table.
table_format Changes to this property will trigger replacement. str
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags Sequence[ExternalTableTagArgs]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

autoRefresh Changes to this property will trigger replacement. Boolean
Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
awsSnsTopic Changes to this property will trigger replacement. String
Specifies the aws sns topic for the external table.
columns Changes to this property will trigger replacement. List<Property Map>
Definitions of a column to create in the external table. Minimum one required.
comment Changes to this property will trigger replacement. String
Specifies a comment for the external table.
copyGrants Changes to this property will trigger replacement. Boolean
Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
database Changes to this property will trigger replacement. String
The database in which to create the external table.
fileFormat Changes to this property will trigger replacement. String
Specifies the file format for the external table.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
location Changes to this property will trigger replacement. String
Specifies a location for the external table, using its FQDN. You can hardcode it ("@MYDB.MYSCHEMA.MYSTAGE"), or populate dynamically ("@${snowflake_stage.mystage.fully_qualified_name}")
name Changes to this property will trigger replacement. String
Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
owner String
Name of the role that owns the external table.
partitionBies Changes to this property will trigger replacement. List<String>
Specifies any partition columns to evaluate for the external table.
pattern Changes to this property will trigger replacement. String
Specifies the file names and/or paths on the external stage to match.
refreshOnCreate Changes to this property will trigger replacement. Boolean
Specifies weather to refresh when an external table is created.
schema Changes to this property will trigger replacement. String
The schema in which to create the external table.
tableFormat Changes to this property will trigger replacement. String
Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
tags List<Property Map>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

Supporting Types

ExternalTableColumn
, ExternalTableColumnArgs

As
This property is required.
Changes to this property will trigger replacement.
string
String that specifies the expression for the column. When queried, the column returns results derived from this expression.
Name
This property is required.
Changes to this property will trigger replacement.
string
Column name
Type
This property is required.
Changes to this property will trigger replacement.
string
Column type, e.g. VARIANT
As
This property is required.
Changes to this property will trigger replacement.
string
String that specifies the expression for the column. When queried, the column returns results derived from this expression.
Name
This property is required.
Changes to this property will trigger replacement.
string
Column name
Type
This property is required.
Changes to this property will trigger replacement.
string
Column type, e.g. VARIANT
as
This property is required.
Changes to this property will trigger replacement.
String
String that specifies the expression for the column. When queried, the column returns results derived from this expression.
name
This property is required.
Changes to this property will trigger replacement.
String
Column name
type
This property is required.
Changes to this property will trigger replacement.
String
Column type, e.g. VARIANT
as
This property is required.
Changes to this property will trigger replacement.
string
String that specifies the expression for the column. When queried, the column returns results derived from this expression.
name
This property is required.
Changes to this property will trigger replacement.
string
Column name
type
This property is required.
Changes to this property will trigger replacement.
string
Column type, e.g. VARIANT
as_
This property is required.
Changes to this property will trigger replacement.
str
String that specifies the expression for the column. When queried, the column returns results derived from this expression.
name
This property is required.
Changes to this property will trigger replacement.
str
Column name
type
This property is required.
Changes to this property will trigger replacement.
str
Column type, e.g. VARIANT
as
This property is required.
Changes to this property will trigger replacement.
String
String that specifies the expression for the column. When queried, the column returns results derived from this expression.
name
This property is required.
Changes to this property will trigger replacement.
String
Column name
type
This property is required.
Changes to this property will trigger replacement.
String
Column type, e.g. VARIANT

ExternalTableTag
, ExternalTableTagArgs

Name This property is required. string
Tag name, e.g. department.
Value This property is required. 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 This property is required. string
Tag name, e.g. department.
Value This property is required. 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 This property is required. String
Tag name, e.g. department.
value This property is required. 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 This property is required. string
Tag name, e.g. department.
value This property is required. 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 This property is required. str
Tag name, e.g. department.
value This property is required. 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 This property is required. String
Tag name, e.g. department.
value This property is required. 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 v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake