snowflake.ExternalTable
Explore with Pulumi AI
Import
format is database name | schema name | external table name
$ pulumi import snowflake:index/externalTable:ExternalTable example 'dbName|schemaName|externalTableName'
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 string
- The unique name of the resource.
- args ExternalTableArgs
- 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 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 string
- The unique name of the resource.
- args ExternalTableArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExternalTableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
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")
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",
});
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
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
List<External
Table Column> - Definitions of a column to create in the external table. Minimum one required.
- Database string
- The database in which to create the external table.
- File
Format string - Specifies the file format for the external table.
- Location string
- Specifies a location for the external table.
- Schema string
- The schema in which to create the external table.
- Auto
Refresh bool - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic - Specifies the aws sns topic for the external table.
- Comment string
- Specifies a comment for the external table.
- Copy
Grants 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 string
- Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
- Partition
Bies List<string> - Specifies any partition columns to evaluate for the external table.
- Pattern string
- Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate - Specifies weather to refresh when an external table is created.
- Table
Format string - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- List<External
Table Tag> - Definitions of a tag to associate with the resource.
- Columns
[]External
Table Column Args - Definitions of a column to create in the external table. Minimum one required.
- Database string
- The database in which to create the external table.
- File
Format string - Specifies the file format for the external table.
- Location string
- Specifies a location for the external table.
- Schema string
- The schema in which to create the external table.
- Auto
Refresh bool - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic - Specifies the aws sns topic for the external table.
- Comment string
- Specifies a comment for the external table.
- Copy
Grants 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 string
- Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
- Partition
Bies []string - Specifies any partition columns to evaluate for the external table.
- Pattern string
- Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate - Specifies weather to refresh when an external table is created.
- Table
Format string - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- []External
Table Tag Args - Definitions of a tag to associate with the resource.
- columns
List<External
Table Column> - Definitions of a column to create in the external table. Minimum one required.
- database String
- The database in which to create the external table.
- file
Format String - Specifies the file format for the external table.
- location String
- Specifies a location for the external table.
- schema String
- The schema in which to create the external table.
- auto
Refresh Boolean - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic - Specifies the aws sns topic for the external table.
- comment String
- Specifies a comment for the external table.
- copy
Grants 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 String
- Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
- partition
Bies List<String> - Specifies any partition columns to evaluate for the external table.
- pattern String
- Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate - Specifies weather to refresh when an external table is created.
- table
Format String - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- List<External
Table Tag> - Definitions of a tag to associate with the resource.
- columns
External
Table Column[] - Definitions of a column to create in the external table. Minimum one required.
- database string
- The database in which to create the external table.
- file
Format string - Specifies the file format for the external table.
- location string
- Specifies a location for the external table.
- schema string
- The schema in which to create the external table.
- auto
Refresh boolean - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns stringTopic - Specifies the aws sns topic for the external table.
- comment string
- Specifies a comment for the external table.
- copy
Grants 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 string
- Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
- partition
Bies string[] - Specifies any partition columns to evaluate for the external table.
- pattern string
- Specifies the file names and/or paths on the external stage to match.
- refresh
On booleanCreate - Specifies weather to refresh when an external table is created.
- table
Format string - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- External
Table Tag[] - Definitions of a tag to associate with the resource.
- columns
Sequence[External
Table Column Args] - Definitions of a column to create in the external table. Minimum one required.
- database str
- The database in which to create the external table.
- file_
format str - Specifies the file format for the external table.
- location str
- Specifies a location for the external table.
- schema str
- The schema in which to create the external table.
- auto_
refresh bool - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws_
sns_ strtopic - Specifies the aws sns topic for the external table.
- comment str
- Specifies a comment for the external table.
- copy_
grants 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 str
- Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
- partition_
bies Sequence[str] - Specifies any partition columns to evaluate for the external table.
- pattern str
- Specifies the file names and/or paths on the external stage to match.
- refresh_
on_ boolcreate - Specifies weather to refresh when an external table is created.
- table_
format str - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- Sequence[External
Table Tag Args] - Definitions of a tag to associate with the resource.
- columns List<Property Map>
- Definitions of a column to create in the external table. Minimum one required.
- database String
- The database in which to create the external table.
- file
Format String - Specifies the file format for the external table.
- location String
- Specifies a location for the external table.
- schema String
- The schema in which to create the external table.
- auto
Refresh Boolean - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic - Specifies the aws sns topic for the external table.
- comment String
- Specifies a comment for the external table.
- copy
Grants 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 String
- Specifies the identifier for the external table; must be unique for the database and schema in which the externalTable is created.
- partition
Bies List<String> - Specifies any partition columns to evaluate for the external table.
- pattern String
- Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate - Specifies weather to refresh when an external table is created.
- table
Format String - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- List<Property Map>
- Definitions of a tag to associate with the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ExternalTable resource produces the following output properties:
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner string
- Name of the role that owns the external table.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner string
- Name of the role that owns the external table.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- owner String
- Name of the role that owns the external table.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- owner string
- Name of the role that owns the external table.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- owner str
- Name of the role that owns the external table.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- 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)
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.
- Auto
Refresh bool - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic - Specifies the aws sns topic for the external table.
- Columns
List<External
Table Column> - Definitions of a column to create in the external table. Minimum one required.
- Comment string
- Specifies a comment for the external table.
- Copy
Grants 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 string
- The database in which to create the external table.
- File
Format string - Specifies the file format for the external table.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Location string
- Specifies a location for the external table.
- Name 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.
- Partition
Bies List<string> - Specifies any partition columns to evaluate for the external table.
- Pattern string
- Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate - Specifies weather to refresh when an external table is created.
- Schema string
- The schema in which to create the external table.
- Table
Format string - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- List<External
Table Tag> - Definitions of a tag to associate with the resource.
- Auto
Refresh bool - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic - Specifies the aws sns topic for the external table.
- Columns
[]External
Table Column Args - Definitions of a column to create in the external table. Minimum one required.
- Comment string
- Specifies a comment for the external table.
- Copy
Grants 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 string
- The database in which to create the external table.
- File
Format string - Specifies the file format for the external table.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Location string
- Specifies a location for the external table.
- Name 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.
- Partition
Bies []string - Specifies any partition columns to evaluate for the external table.
- Pattern string
- Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate - Specifies weather to refresh when an external table is created.
- Schema string
- The schema in which to create the external table.
- Table
Format string - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- []External
Table Tag Args - Definitions of a tag to associate with the resource.
- auto
Refresh Boolean - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic - Specifies the aws sns topic for the external table.
- columns
List<External
Table Column> - Definitions of a column to create in the external table. Minimum one required.
- comment String
- Specifies a comment for the external table.
- copy
Grants 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 String
- The database in which to create the external table.
- file
Format String - Specifies the file format for the external table.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- location String
- Specifies a location for the external table.
- name 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.
- partition
Bies List<String> - Specifies any partition columns to evaluate for the external table.
- pattern String
- Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate - Specifies weather to refresh when an external table is created.
- schema String
- The schema in which to create the external table.
- table
Format String - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- List<External
Table Tag> - Definitions of a tag to associate with the resource.
- auto
Refresh boolean - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns stringTopic - Specifies the aws sns topic for the external table.
- columns
External
Table Column[] - Definitions of a column to create in the external table. Minimum one required.
- comment string
- Specifies a comment for the external table.
- copy
Grants 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 string
- The database in which to create the external table.
- file
Format string - Specifies the file format for the external table.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- location string
- Specifies a location for the external table.
- name 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.
- partition
Bies string[] - Specifies any partition columns to evaluate for the external table.
- pattern string
- Specifies the file names and/or paths on the external stage to match.
- refresh
On booleanCreate - Specifies weather to refresh when an external table is created.
- schema string
- The schema in which to create the external table.
- table
Format string - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- External
Table Tag[] - Definitions of a tag to associate with the resource.
- auto_
refresh bool - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws_
sns_ strtopic - Specifies the aws sns topic for the external table.
- columns
Sequence[External
Table Column Args] - Definitions of a column to create in the external table. Minimum one required.
- comment str
- Specifies a comment for the external table.
- copy_
grants 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 str
- The database in which to create the external table.
- file_
format str - Specifies the file format for the external table.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- location str
- Specifies a location for the external table.
- name 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 Sequence[str] - Specifies any partition columns to evaluate for the external table.
- pattern str
- Specifies the file names and/or paths on the external stage to match.
- refresh_
on_ boolcreate - Specifies weather to refresh when an external table is created.
- schema str
- The schema in which to create the external table.
- table_
format str - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- Sequence[External
Table Tag Args] - Definitions of a tag to associate with the resource.
- auto
Refresh Boolean - Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic - Specifies the aws sns topic for the external table.
- columns List<Property Map>
- Definitions of a column to create in the external table. Minimum one required.
- comment String
- Specifies a comment for the external table.
- copy
Grants 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 String
- The database in which to create the external table.
- file
Format String - Specifies the file format for the external table.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- location String
- Specifies a location for the external table.
- name 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.
- partition
Bies List<String> - Specifies any partition columns to evaluate for the external table.
- pattern String
- Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate - Specifies weather to refresh when an external table is created.
- schema String
- The schema in which to create the external table.
- table
Format String - Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
- List<Property Map>
- Definitions of a tag to associate with the resource.
Supporting Types
ExternalTableColumn, ExternalTableColumnArgs
ExternalTableTag, ExternalTableTagArgs
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflake
Terraform Provider.