Skip to content

Latest commit

 

History

History
2668 lines (1651 loc) · 106 KB

externalTable.go.md

File metadata and controls

2668 lines (1651 loc) · 106 KB

externalTable Submodule

Constructs

ExternalTable

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table snowflake_external_table}.

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.NewExternalTable(scope Construct, id *string, config ExternalTableConfig) ExternalTable
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config ExternalTableConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutColumn No description.
PutTag No description.
ResetAutoRefresh No description.
ResetAwsSnsTopic No description.
ResetComment No description.
ResetCopyGrants No description.
ResetId No description.
ResetPartitionBy No description.
ResetPattern No description.
ResetRefreshOnCreate No description.
ResetTableFormat No description.
ResetTag No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

PutColumn 
func PutColumn(value interface{})
valueRequired
  • Type: interface{}
PutTag 
func PutTag(value interface{})
valueRequired
  • Type: interface{}
ResetAutoRefresh 
func ResetAutoRefresh()
ResetAwsSnsTopic 
func ResetAwsSnsTopic()
ResetComment 
func ResetComment()
ResetCopyGrants 
func ResetCopyGrants()
ResetId 
func ResetId()
ResetPartitionBy 
func ResetPartitionBy()
ResetPattern 
func ResetPattern()
ResetRefreshOnCreate 
func ResetRefreshOnCreate()
ResetTableFormat 
func ResetTableFormat()
ResetTag 
func ResetTag()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a ExternalTable resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.ExternalTable_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.ExternalTable_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.ExternalTable_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.ExternalTable_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a ExternalTable resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

The construct id used in the generated config for the ExternalTable to import.

importFromIdRequired
  • Type: *string

The id of the existing ExternalTable that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the ExternalTable to import is found.

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Column ExternalTableColumnList No description.
FullyQualifiedName *string No description.
Owner *string No description.
Tag ExternalTableTagList No description.
AutoRefreshInput interface{} No description.
AwsSnsTopicInput *string No description.
ColumnInput interface{} No description.
CommentInput *string No description.
CopyGrantsInput interface{} No description.
DatabaseInput *string No description.
FileFormatInput *string No description.
IdInput *string No description.
LocationInput *string No description.
NameInput *string No description.
PartitionByInput *[]*string No description.
PatternInput *string No description.
RefreshOnCreateInput interface{} No description.
SchemaInput *string No description.
TableFormatInput *string No description.
TagInput interface{} No description.
AutoRefresh interface{} No description.
AwsSnsTopic *string No description.
Comment *string No description.
CopyGrants interface{} No description.
Database *string No description.
FileFormat *string No description.
Id *string No description.
Location *string No description.
Name *string No description.
PartitionBy *[]*string No description.
Pattern *string No description.
RefreshOnCreate interface{} No description.
Schema *string No description.
TableFormat *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
ColumnRequired 
func Column() ExternalTableColumnList
FullyQualifiedNameRequired 
func FullyQualifiedName() *string
  • Type: *string
OwnerRequired 
func Owner() *string
  • Type: *string
TagRequired 
func Tag() ExternalTableTagList
AutoRefreshInputOptional 
func AutoRefreshInput() interface{}
  • Type: interface{}
AwsSnsTopicInputOptional 
func AwsSnsTopicInput() *string
  • Type: *string
ColumnInputOptional 
func ColumnInput() interface{}
  • Type: interface{}
CommentInputOptional 
func CommentInput() *string
  • Type: *string
CopyGrantsInputOptional 
func CopyGrantsInput() interface{}
  • Type: interface{}
DatabaseInputOptional 
func DatabaseInput() *string
  • Type: *string
FileFormatInputOptional 
func FileFormatInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
LocationInputOptional 
func LocationInput() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
PartitionByInputOptional 
func PartitionByInput() *[]*string
  • Type: *[]*string
PatternInputOptional 
func PatternInput() *string
  • Type: *string
RefreshOnCreateInputOptional 
func RefreshOnCreateInput() interface{}
  • Type: interface{}
SchemaInputOptional 
func SchemaInput() *string
  • Type: *string
TableFormatInputOptional 
func TableFormatInput() *string
  • Type: *string
TagInputOptional 
func TagInput() interface{}
  • Type: interface{}
AutoRefreshRequired 
func AutoRefresh() interface{}
  • Type: interface{}
AwsSnsTopicRequired 
func AwsSnsTopic() *string
  • Type: *string
CommentRequired 
func Comment() *string
  • Type: *string
CopyGrantsRequired 
func CopyGrants() interface{}
  • Type: interface{}
DatabaseRequired 
func Database() *string
  • Type: *string
FileFormatRequired 
func FileFormat() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
LocationRequired 
func Location() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string
PartitionByRequired 
func PartitionBy() *[]*string
  • Type: *[]*string
PatternRequired 
func Pattern() *string
  • Type: *string
RefreshOnCreateRequired 
func RefreshOnCreate() interface{}
  • Type: interface{}
SchemaRequired 
func Schema() *string
  • Type: *string
TableFormatRequired 
func TableFormat() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

ExternalTableColumn

Initializer 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

&externaltable.ExternalTableColumn {
	As: *string,
	Name: *string,
	Type: *string,
}

Properties

Name Type Description
As *string String that specifies the expression for the column. When queried, the column returns results derived from this expression.
Name *string Column name.
Type *string Column type, e.g. VARIANT.
AsRequired 
As *string
  • Type: *string

String that specifies the expression for the column. When queried, the column returns results derived from this expression.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#as ExternalTable#as}

NameRequired 
Name *string
  • Type: *string

Column name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#name ExternalTable#name}

TypeRequired 
Type *string
  • Type: *string

Column type, e.g. VARIANT.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#type ExternalTable#type}

ExternalTableConfig

Initializer 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

&externaltable.ExternalTableConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Column: interface{},
	Database: *string,
	FileFormat: *string,
	Location: *string,
	Name: *string,
	Schema: *string,
	AutoRefresh: interface{},
	AwsSnsTopic: *string,
	Comment: *string,
	CopyGrants: interface{},
	Id: *string,
	PartitionBy: *[]*string,
	Pattern: *string,
	RefreshOnCreate: interface{},
	TableFormat: *string,
	Tag: interface{},
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Column interface{} column block.
Database *string The database in which to create the external table.
FileFormat *string Specifies the file format for the external table.
Location *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 *string Specifies the identifier for the external table;
Schema *string The schema in which to create the external table.
AutoRefresh interface{} Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
AwsSnsTopic *string Specifies the aws sns topic for the external table.
Comment *string Specifies a comment for the external table.
CopyGrants interface{} Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#id ExternalTable#id}.
PartitionBy *[]*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.
RefreshOnCreate interface{} Specifies weather to refresh when an external table is created.
TableFormat *string Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.
Tag interface{} tag block.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
ColumnRequired 
Column interface{}
  • Type: interface{}

column block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#column ExternalTable#column}

DatabaseRequired 
Database *string
  • Type: *string

The database in which to create the external table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#database ExternalTable#database}

FileFormatRequired 
FileFormat *string
  • Type: *string

Specifies the file format for the external table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#file_format ExternalTable#file_format}

LocationRequired 
Location *string
  • Type: *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}").

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#location ExternalTable#location}

NameRequired 
Name *string
  • Type: *string

Specifies the identifier for the external table;

must be unique for the database and schema in which the externalTable is created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#name ExternalTable#name}

SchemaRequired 
Schema *string
  • Type: *string

The schema in which to create the external table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#schema ExternalTable#schema}

AutoRefreshOptional 
AutoRefresh interface{}
  • Type: interface{}

Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#auto_refresh ExternalTable#auto_refresh}

AwsSnsTopicOptional 
AwsSnsTopic *string
  • Type: *string

Specifies the aws sns topic for the external table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#aws_sns_topic ExternalTable#aws_sns_topic}

CommentOptional 
Comment *string
  • Type: *string

Specifies a comment for the external table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#comment ExternalTable#comment}

CopyGrantsOptional 
CopyGrants interface{}
  • Type: interface{}

Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#copy_grants ExternalTable#copy_grants}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#id ExternalTable#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

PartitionByOptional 
PartitionBy *[]*string
  • Type: *[]*string

Specifies any partition columns to evaluate for the external table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#partition_by ExternalTable#partition_by}

PatternOptional 
Pattern *string
  • Type: *string

Specifies the file names and/or paths on the external stage to match.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#pattern ExternalTable#pattern}

RefreshOnCreateOptional 
RefreshOnCreate interface{}
  • Type: interface{}

Specifies weather to refresh when an external table is created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#refresh_on_create ExternalTable#refresh_on_create}

TableFormatOptional 
TableFormat *string
  • Type: *string

Identifies the external table table type. For now, only "delta" for Delta Lake table format is supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#table_format ExternalTable#table_format}

TagOptional 
Tag interface{}
  • Type: interface{}

tag block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#tag ExternalTable#tag}

ExternalTableTag

Initializer 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

&externaltable.ExternalTableTag {
	Name: *string,
	Value: *string,
	Database: *string,
	Schema: *string,
}

Properties

Name Type Description
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.
NameRequired 
Name *string
  • Type: *string

Tag name, e.g. department.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#name ExternalTable#name}

ValueRequired 
Value *string
  • Type: *string

Tag value, e.g. marketing_info.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#value ExternalTable#value}

DatabaseOptional 
Database *string
  • Type: *string

Name of the database that the tag was created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#database ExternalTable#database}

SchemaOptional 
Schema *string
  • Type: *string

Name of the schema that the tag was created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_table#schema ExternalTable#schema}

Classes

ExternalTableColumnList

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.NewExternalTableColumnList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) ExternalTableColumnList
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
wrapsSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.
AllWithMapKey 
func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: *string
ComputeFqn 
func ComputeFqn() *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
func Get(index *f64) ExternalTableColumnOutputReference
indexRequired
  • Type: *f64

the index of the item to return.

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
func Fqn() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

ExternalTableColumnOutputReference

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.NewExternalTableColumnOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) ExternalTableColumnOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
complexObjectIndex *f64 the index of this item in the list.
complexObjectIsFromSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: *f64

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ComputeFqn 
func ComputeFqn() *string
GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
AsInput *string No description.
NameInput *string No description.
TypeInput *string No description.
As *string No description.
Name *string No description.
Type *string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
func Fqn() *string
  • Type: *string
AsInputOptional 
func AsInput() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
TypeInputOptional 
func TypeInput() *string
  • Type: *string
AsRequired 
func As() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string
TypeRequired 
func Type() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

ExternalTableTagList

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.NewExternalTableTagList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) ExternalTableTagList
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
wrapsSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.
AllWithMapKey 
func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: *string
ComputeFqn 
func ComputeFqn() *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
func Get(index *f64) ExternalTableTagOutputReference
indexRequired
  • Type: *f64

the index of the item to return.

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
func Fqn() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

ExternalTableTagOutputReference

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externaltable"

externaltable.NewExternalTableTagOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) ExternalTableTagOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
complexObjectIndex *f64 the index of this item in the list.
complexObjectIsFromSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: *f64

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetDatabase No description.
ResetSchema No description.
ComputeFqn 
func ComputeFqn() *string
GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetDatabase 
func ResetDatabase()
ResetSchema 
func ResetSchema()

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
DatabaseInput *string No description.
NameInput *string No description.
SchemaInput *string No description.
ValueInput *string No description.
Database *string No description.
Name *string No description.
Schema *string No description.
Value *string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
func Fqn() *string
  • Type: *string
DatabaseInputOptional 
func DatabaseInput() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
SchemaInputOptional 
func SchemaInput() *string
  • Type: *string
ValueInputOptional 
func ValueInput() *string
  • Type: *string
DatabaseRequired 
func Database() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string
SchemaRequired 
func Schema() *string
  • Type: *string
ValueRequired 
func Value() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}