Skip to content

Latest commit

 

History

History
2419 lines (1534 loc) · 95.4 KB

fileFormat.go.md

File metadata and controls

2419 lines (1534 loc) · 95.4 KB

fileFormat Submodule

Constructs

FileFormat

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

Initializers 

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

fileformat.NewFileFormat(scope Construct, id *string, config FileFormatConfig) FileFormat
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 FileFormatConfig 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".
ResetAllowDuplicate No description.
ResetBinaryAsText No description.
ResetBinaryFormat No description.
ResetComment No description.
ResetCompression No description.
ResetDateFormat No description.
ResetDisableAutoConvert No description.
ResetDisableSnowflakeData No description.
ResetEmptyFieldAsNull No description.
ResetEnableOctal No description.
ResetEncoding No description.
ResetErrorOnColumnCountMismatch No description.
ResetEscape No description.
ResetEscapeUnenclosedField No description.
ResetFieldDelimiter No description.
ResetFieldOptionallyEnclosedBy No description.
ResetFileExtension No description.
ResetId No description.
ResetIgnoreUtf8Errors No description.
ResetNullIf No description.
ResetParseHeader No description.
ResetPreserveSpace No description.
ResetRecordDelimiter No description.
ResetReplaceInvalidCharacters No description.
ResetSkipBlankLines No description.
ResetSkipByteOrderMark No description.
ResetSkipHeader No description.
ResetStripNullValues No description.
ResetStripOuterArray No description.
ResetStripOuterElement No description.
ResetTimeFormat No description.
ResetTimestampFormat No description.
ResetTrimSpace 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".

ResetAllowDuplicate 
func ResetAllowDuplicate()
ResetBinaryAsText 
func ResetBinaryAsText()
ResetBinaryFormat 
func ResetBinaryFormat()
ResetComment 
func ResetComment()
ResetCompression 
func ResetCompression()
ResetDateFormat 
func ResetDateFormat()
ResetDisableAutoConvert 
func ResetDisableAutoConvert()
ResetDisableSnowflakeData 
func ResetDisableSnowflakeData()
ResetEmptyFieldAsNull 
func ResetEmptyFieldAsNull()
ResetEnableOctal 
func ResetEnableOctal()
ResetEncoding 
func ResetEncoding()
ResetErrorOnColumnCountMismatch 
func ResetErrorOnColumnCountMismatch()
ResetEscape 
func ResetEscape()
ResetEscapeUnenclosedField 
func ResetEscapeUnenclosedField()
ResetFieldDelimiter 
func ResetFieldDelimiter()
ResetFieldOptionallyEnclosedBy 
func ResetFieldOptionallyEnclosedBy()
ResetFileExtension 
func ResetFileExtension()
ResetId 
func ResetId()
ResetIgnoreUtf8Errors 
func ResetIgnoreUtf8Errors()
ResetNullIf 
func ResetNullIf()
ResetParseHeader 
func ResetParseHeader()
ResetPreserveSpace 
func ResetPreserveSpace()
ResetRecordDelimiter 
func ResetRecordDelimiter()
ResetReplaceInvalidCharacters 
func ResetReplaceInvalidCharacters()
ResetSkipBlankLines 
func ResetSkipBlankLines()
ResetSkipByteOrderMark 
func ResetSkipByteOrderMark()
ResetSkipHeader 
func ResetSkipHeader()
ResetStripNullValues 
func ResetStripNullValues()
ResetStripOuterArray 
func ResetStripOuterArray()
ResetStripOuterElement 
func ResetStripOuterElement()
ResetTimeFormat 
func ResetTimeFormat()
ResetTimestampFormat 
func ResetTimestampFormat()
ResetTrimSpace 
func ResetTrimSpace()

Static Functions

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

fileformat.FileFormat_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/fileformat"

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

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

fileformat.FileFormat_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a FileFormat 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 FileFormat to import.

importFromIdRequired
  • Type: *string

The id of the existing FileFormat that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/file_format#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 FileFormat 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.
FullyQualifiedName *string No description.
AllowDuplicateInput interface{} No description.
BinaryAsTextInput interface{} No description.
BinaryFormatInput *string No description.
CommentInput *string No description.
CompressionInput *string No description.
DatabaseInput *string No description.
DateFormatInput *string No description.
DisableAutoConvertInput interface{} No description.
DisableSnowflakeDataInput interface{} No description.
EmptyFieldAsNullInput interface{} No description.
EnableOctalInput interface{} No description.
EncodingInput *string No description.
ErrorOnColumnCountMismatchInput interface{} No description.
EscapeInput *string No description.
EscapeUnenclosedFieldInput *string No description.
FieldDelimiterInput *string No description.
FieldOptionallyEnclosedByInput *string No description.
FileExtensionInput *string No description.
FormatTypeInput *string No description.
IdInput *string No description.
IgnoreUtf8ErrorsInput interface{} No description.
NameInput *string No description.
NullIfInput *[]*string No description.
ParseHeaderInput interface{} No description.
PreserveSpaceInput interface{} No description.
RecordDelimiterInput *string No description.
ReplaceInvalidCharactersInput interface{} No description.
SchemaInput *string No description.
SkipBlankLinesInput interface{} No description.
SkipByteOrderMarkInput interface{} No description.
SkipHeaderInput *f64 No description.
StripNullValuesInput interface{} No description.
StripOuterArrayInput interface{} No description.
StripOuterElementInput interface{} No description.
TimeFormatInput *string No description.
TimestampFormatInput *string No description.
TrimSpaceInput interface{} No description.
AllowDuplicate interface{} No description.
BinaryAsText interface{} No description.
BinaryFormat *string No description.
Comment *string No description.
Compression *string No description.
Database *string No description.
DateFormat *string No description.
DisableAutoConvert interface{} No description.
DisableSnowflakeData interface{} No description.
EmptyFieldAsNull interface{} No description.
EnableOctal interface{} No description.
Encoding *string No description.
ErrorOnColumnCountMismatch interface{} No description.
Escape *string No description.
EscapeUnenclosedField *string No description.
FieldDelimiter *string No description.
FieldOptionallyEnclosedBy *string No description.
FileExtension *string No description.
FormatType *string No description.
Id *string No description.
IgnoreUtf8Errors interface{} No description.
Name *string No description.
NullIf *[]*string No description.
ParseHeader interface{} No description.
PreserveSpace interface{} No description.
RecordDelimiter *string No description.
ReplaceInvalidCharacters interface{} No description.
Schema *string No description.
SkipBlankLines interface{} No description.
SkipByteOrderMark interface{} No description.
SkipHeader *f64 No description.
StripNullValues interface{} No description.
StripOuterArray interface{} No description.
StripOuterElement interface{} No description.
TimeFormat *string No description.
TimestampFormat *string No description.
TrimSpace interface{} 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{}
FullyQualifiedNameRequired 
func FullyQualifiedName() *string
  • Type: *string
AllowDuplicateInputOptional 
func AllowDuplicateInput() interface{}
  • Type: interface{}
BinaryAsTextInputOptional 
func BinaryAsTextInput() interface{}
  • Type: interface{}
BinaryFormatInputOptional 
func BinaryFormatInput() *string
  • Type: *string
CommentInputOptional 
func CommentInput() *string
  • Type: *string
CompressionInputOptional 
func CompressionInput() *string
  • Type: *string
DatabaseInputOptional 
func DatabaseInput() *string
  • Type: *string
DateFormatInputOptional 
func DateFormatInput() *string
  • Type: *string
DisableAutoConvertInputOptional 
func DisableAutoConvertInput() interface{}
  • Type: interface{}
DisableSnowflakeDataInputOptional 
func DisableSnowflakeDataInput() interface{}
  • Type: interface{}
EmptyFieldAsNullInputOptional 
func EmptyFieldAsNullInput() interface{}
  • Type: interface{}
EnableOctalInputOptional 
func EnableOctalInput() interface{}
  • Type: interface{}
EncodingInputOptional 
func EncodingInput() *string
  • Type: *string
ErrorOnColumnCountMismatchInputOptional 
func ErrorOnColumnCountMismatchInput() interface{}
  • Type: interface{}
EscapeInputOptional 
func EscapeInput() *string
  • Type: *string
EscapeUnenclosedFieldInputOptional 
func EscapeUnenclosedFieldInput() *string
  • Type: *string
FieldDelimiterInputOptional 
func FieldDelimiterInput() *string
  • Type: *string
FieldOptionallyEnclosedByInputOptional 
func FieldOptionallyEnclosedByInput() *string
  • Type: *string
FileExtensionInputOptional 
func FileExtensionInput() *string
  • Type: *string
FormatTypeInputOptional 
func FormatTypeInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
IgnoreUtf8ErrorsInputOptional 
func IgnoreUtf8ErrorsInput() interface{}
  • Type: interface{}
NameInputOptional 
func NameInput() *string
  • Type: *string
NullIfInputOptional 
func NullIfInput() *[]*string
  • Type: *[]*string
ParseHeaderInputOptional 
func ParseHeaderInput() interface{}
  • Type: interface{}
PreserveSpaceInputOptional 
func PreserveSpaceInput() interface{}
  • Type: interface{}
RecordDelimiterInputOptional 
func RecordDelimiterInput() *string
  • Type: *string
ReplaceInvalidCharactersInputOptional 
func ReplaceInvalidCharactersInput() interface{}
  • Type: interface{}
SchemaInputOptional 
func SchemaInput() *string
  • Type: *string
SkipBlankLinesInputOptional 
func SkipBlankLinesInput() interface{}
  • Type: interface{}
SkipByteOrderMarkInputOptional 
func SkipByteOrderMarkInput() interface{}
  • Type: interface{}
SkipHeaderInputOptional 
func SkipHeaderInput() *f64
  • Type: *f64
StripNullValuesInputOptional 
func StripNullValuesInput() interface{}
  • Type: interface{}
StripOuterArrayInputOptional 
func StripOuterArrayInput() interface{}
  • Type: interface{}
StripOuterElementInputOptional 
func StripOuterElementInput() interface{}
  • Type: interface{}
TimeFormatInputOptional 
func TimeFormatInput() *string
  • Type: *string
TimestampFormatInputOptional 
func TimestampFormatInput() *string
  • Type: *string
TrimSpaceInputOptional 
func TrimSpaceInput() interface{}
  • Type: interface{}
AllowDuplicateRequired 
func AllowDuplicate() interface{}
  • Type: interface{}
BinaryAsTextRequired 
func BinaryAsText() interface{}
  • Type: interface{}
BinaryFormatRequired 
func BinaryFormat() *string
  • Type: *string
CommentRequired 
func Comment() *string
  • Type: *string
CompressionRequired 
func Compression() *string
  • Type: *string
DatabaseRequired 
func Database() *string
  • Type: *string
DateFormatRequired 
func DateFormat() *string
  • Type: *string
DisableAutoConvertRequired 
func DisableAutoConvert() interface{}
  • Type: interface{}
DisableSnowflakeDataRequired 
func DisableSnowflakeData() interface{}
  • Type: interface{}
EmptyFieldAsNullRequired 
func EmptyFieldAsNull() interface{}
  • Type: interface{}
EnableOctalRequired 
func EnableOctal() interface{}
  • Type: interface{}
EncodingRequired 
func Encoding() *string
  • Type: *string
ErrorOnColumnCountMismatchRequired 
func ErrorOnColumnCountMismatch() interface{}
  • Type: interface{}
EscapeRequired 
func Escape() *string
  • Type: *string
EscapeUnenclosedFieldRequired 
func EscapeUnenclosedField() *string
  • Type: *string
FieldDelimiterRequired 
func FieldDelimiter() *string
  • Type: *string
FieldOptionallyEnclosedByRequired 
func FieldOptionallyEnclosedBy() *string
  • Type: *string
FileExtensionRequired 
func FileExtension() *string
  • Type: *string
FormatTypeRequired 
func FormatType() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
IgnoreUtf8ErrorsRequired 
func IgnoreUtf8Errors() interface{}
  • Type: interface{}
NameRequired 
func Name() *string
  • Type: *string
NullIfRequired 
func NullIf() *[]*string
  • Type: *[]*string
ParseHeaderRequired 
func ParseHeader() interface{}
  • Type: interface{}
PreserveSpaceRequired 
func PreserveSpace() interface{}
  • Type: interface{}
RecordDelimiterRequired 
func RecordDelimiter() *string
  • Type: *string
ReplaceInvalidCharactersRequired 
func ReplaceInvalidCharacters() interface{}
  • Type: interface{}
SchemaRequired 
func Schema() *string
  • Type: *string
SkipBlankLinesRequired 
func SkipBlankLines() interface{}
  • Type: interface{}
SkipByteOrderMarkRequired 
func SkipByteOrderMark() interface{}
  • Type: interface{}
SkipHeaderRequired 
func SkipHeader() *f64
  • Type: *f64
StripNullValuesRequired 
func StripNullValues() interface{}
  • Type: interface{}
StripOuterArrayRequired 
func StripOuterArray() interface{}
  • Type: interface{}
StripOuterElementRequired 
func StripOuterElement() interface{}
  • Type: interface{}
TimeFormatRequired 
func TimeFormat() *string
  • Type: *string
TimestampFormatRequired 
func TimestampFormat() *string
  • Type: *string
TrimSpaceRequired 
func TrimSpace() interface{}
  • Type: interface{}

Constants

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

Structs

FileFormatConfig

Initializer 

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

&fileformat.FileFormatConfig {
	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{},
	Database: *string,
	FormatType: *string,
	Name: *string,
	Schema: *string,
	AllowDuplicate: interface{},
	BinaryAsText: interface{},
	BinaryFormat: *string,
	Comment: *string,
	Compression: *string,
	DateFormat: *string,
	DisableAutoConvert: interface{},
	DisableSnowflakeData: interface{},
	EmptyFieldAsNull: interface{},
	EnableOctal: interface{},
	Encoding: *string,
	ErrorOnColumnCountMismatch: interface{},
	Escape: *string,
	EscapeUnenclosedField: *string,
	FieldDelimiter: *string,
	FieldOptionallyEnclosedBy: *string,
	FileExtension: *string,
	Id: *string,
	IgnoreUtf8Errors: interface{},
	NullIf: *[]*string,
	ParseHeader: interface{},
	PreserveSpace: interface{},
	RecordDelimiter: *string,
	ReplaceInvalidCharacters: interface{},
	SkipBlankLines: interface{},
	SkipByteOrderMark: interface{},
	SkipHeader: *f64,
	StripNullValues: interface{},
	StripOuterArray: interface{},
	StripOuterElement: interface{},
	TimeFormat: *string,
	TimestampFormat: *string,
	TrimSpace: 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.
Database *string The database in which to create the file format.
FormatType *string Specifies the format of the input files (for data loading) or output files (for data unloading).
Name *string Specifies the identifier for the file format;
Schema *string The schema in which to create the file format.
AllowDuplicate interface{} Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
BinaryAsText interface{} Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
BinaryFormat *string Defines the encoding format for binary input or output.
Comment *string Specifies a comment for the file format.
Compression *string Specifies the current compression algorithm for the data file.
DateFormat *string Defines the format of date values in the data files (data loading) or table (data unloading).
DisableAutoConvert interface{} Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
DisableSnowflakeData interface{} Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
EmptyFieldAsNull interface{} Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
EnableOctal interface{} Boolean that enables parsing of octal numbers.
Encoding *string String (constant) that specifies the character set of the source data when loading data into a table.
ErrorOnColumnCountMismatch interface{} Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
Escape *string Single character string used as the escape character for field values.
EscapeUnenclosedField *string Single character string used as the escape character for unenclosed field values only.
FieldDelimiter *string Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
FieldOptionallyEnclosedBy *string Character used to enclose strings.
FileExtension *string Specifies the extension for files unloaded to a stage.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/file_format#id FileFormat#id}.
IgnoreUtf8Errors interface{} Boolean that specifies whether UTF-8 encoding errors produce error conditions.
NullIf *[]*string String used to convert to and from SQL NULL.
ParseHeader interface{} Boolean that specifies whether to use the first row headers in the data files to determine column names.
PreserveSpace interface{} Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
RecordDelimiter *string Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
ReplaceInvalidCharacters interface{} Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
SkipBlankLines interface{} Boolean that specifies to skip any blank lines encountered in the data files.
SkipByteOrderMark interface{} Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
SkipHeader *f64 Number of lines at the start of the file to skip.
StripNullValues interface{} Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
StripOuterArray interface{} Boolean that instructs the JSON parser to remove outer brackets.
StripOuterElement interface{} Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
TimeFormat *string Defines the format of time values in the data files (data loading) or table (data unloading).
TimestampFormat *string Defines the format of timestamp values in the data files (data loading) or table (data unloading).
TrimSpace interface{} Boolean that specifies whether to remove white space from fields.
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{}
DatabaseRequired 
Database *string
  • Type: *string

The database in which to create the file format.

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

FormatTypeRequired 
FormatType *string
  • Type: *string

Specifies the format of the input files (for data loading) or output files (for data unloading).

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

NameRequired 
Name *string
  • Type: *string

Specifies the identifier for the file format;

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

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

SchemaRequired 
Schema *string
  • Type: *string

The schema in which to create the file format.

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

AllowDuplicateOptional 
AllowDuplicate interface{}
  • Type: interface{}

Boolean that specifies to allow duplicate object field names (only the last one will be preserved).

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

BinaryAsTextOptional 
BinaryAsText interface{}
  • Type: interface{}

Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.

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

BinaryFormatOptional 
BinaryFormat *string
  • Type: *string

Defines the encoding format for binary input or output.

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

CommentOptional 
Comment *string
  • Type: *string

Specifies a comment for the file format.

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

CompressionOptional 
Compression *string
  • Type: *string

Specifies the current compression algorithm for the data file.

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

DateFormatOptional 
DateFormat *string
  • Type: *string

Defines the format of date values in the data files (data loading) or table (data unloading).

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

DisableAutoConvertOptional 
DisableAutoConvert interface{}
  • Type: interface{}

Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.

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

DisableSnowflakeDataOptional 
DisableSnowflakeData interface{}
  • Type: interface{}

Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.

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

EmptyFieldAsNullOptional 
EmptyFieldAsNull interface{}
  • Type: interface{}

Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.

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

EnableOctalOptional 
EnableOctal interface{}
  • Type: interface{}

Boolean that enables parsing of octal numbers.

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

EncodingOptional 
Encoding *string
  • Type: *string

String (constant) that specifies the character set of the source data when loading data into a table.

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

ErrorOnColumnCountMismatchOptional 
ErrorOnColumnCountMismatch interface{}
  • Type: interface{}

Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.

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

EscapeOptional 
Escape *string
  • Type: *string

Single character string used as the escape character for field values.

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

EscapeUnenclosedFieldOptional 
EscapeUnenclosedField *string
  • Type: *string

Single character string used as the escape character for unenclosed field values only.

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

FieldDelimiterOptional 
FieldDelimiter *string
  • Type: *string

Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).

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

FieldOptionallyEnclosedByOptional 
FieldOptionallyEnclosedBy *string
  • Type: *string

Character used to enclose strings.

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

FileExtensionOptional 
FileExtension *string
  • Type: *string

Specifies the extension for files unloaded to a stage.

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

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/file_format#id FileFormat#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.

IgnoreUtf8ErrorsOptional 
IgnoreUtf8Errors interface{}
  • Type: interface{}

Boolean that specifies whether UTF-8 encoding errors produce error conditions.

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

NullIfOptional 
NullIf *[]*string
  • Type: *[]*string

String used to convert to and from SQL NULL.

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

ParseHeaderOptional 
ParseHeader interface{}
  • Type: interface{}

Boolean that specifies whether to use the first row headers in the data files to determine column names.

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

PreserveSpaceOptional 
PreserveSpace interface{}
  • Type: interface{}

Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.

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

RecordDelimiterOptional 
RecordDelimiter *string
  • Type: *string

Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).

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

ReplaceInvalidCharactersOptional 
ReplaceInvalidCharacters interface{}
  • Type: interface{}

Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).

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

SkipBlankLinesOptional 
SkipBlankLines interface{}
  • Type: interface{}

Boolean that specifies to skip any blank lines encountered in the data files.

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

SkipByteOrderMarkOptional 
SkipByteOrderMark interface{}
  • Type: interface{}

Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.

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

SkipHeaderOptional 
SkipHeader *f64
  • Type: *f64

Number of lines at the start of the file to skip.

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

StripNullValuesOptional 
StripNullValues interface{}
  • Type: interface{}

Boolean that instructs the JSON parser to remove object fields or array elements containing null values.

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

StripOuterArrayOptional 
StripOuterArray interface{}
  • Type: interface{}

Boolean that instructs the JSON parser to remove outer brackets.

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

StripOuterElementOptional 
StripOuterElement interface{}
  • Type: interface{}

Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.

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

TimeFormatOptional 
TimeFormat *string
  • Type: *string

Defines the format of time values in the data files (data loading) or table (data unloading).

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

TimestampFormatOptional 
TimestampFormat *string
  • Type: *string

Defines the format of timestamp values in the data files (data loading) or table (data unloading).

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

TrimSpaceOptional 
TrimSpace interface{}
  • Type: interface{}

Boolean that specifies whether to remove white space from fields.

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