Documentation ¶
Index ¶
- func FileFormat_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func FileFormat_IsConstruct(x interface{}) *bool
- func FileFormat_IsTerraformElement(x interface{}) *bool
- func FileFormat_IsTerraformResource(x interface{}) *bool
- func FileFormat_TfResourceType() *string
- func NewFileFormat_Override(f FileFormat, scope constructs.Construct, id *string, config *FileFormatConfig)
- type FileFormat
- type FileFormatConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FileFormat_GenerateConfigForImport ¶
func FileFormat_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a FileFormat resource upon running "cdktf plan <stack-name>".
func FileFormat_IsConstruct ¶
func 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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func FileFormat_IsTerraformElement ¶
func FileFormat_IsTerraformElement(x interface{}) *bool
Experimental.
func FileFormat_IsTerraformResource ¶
func FileFormat_IsTerraformResource(x interface{}) *bool
Experimental.
func FileFormat_TfResourceType ¶
func FileFormat_TfResourceType() *string
func NewFileFormat_Override ¶
func NewFileFormat_Override(f FileFormat, scope constructs.Construct, id *string, config *FileFormatConfig)
Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format snowflake_file_format} Resource.
Types ¶
type FileFormat ¶
type FileFormat interface { cdktf.TerraformResource AllowDuplicate() interface{} SetAllowDuplicate(val interface{}) AllowDuplicateInput() interface{} BinaryAsText() interface{} SetBinaryAsText(val interface{}) BinaryAsTextInput() interface{} BinaryFormat() *string SetBinaryFormat(val *string) BinaryFormatInput() *string // Experimental. CdktfStack() cdktf.TerraformStack Comment() *string SetComment(val *string) CommentInput() *string Compression() *string SetCompression(val *string) CompressionInput() *string // Experimental. Connection() interface{} // Experimental. SetConnection(val interface{}) // Experimental. ConstructNodeMetadata() *map[string]interface{} // Experimental. Count() interface{} // Experimental. SetCount(val interface{}) Database() *string SetDatabase(val *string) DatabaseInput() *string DateFormat() *string SetDateFormat(val *string) DateFormatInput() *string // Experimental. DependsOn() *[]*string // Experimental. SetDependsOn(val *[]*string) DisableAutoConvert() interface{} SetDisableAutoConvert(val interface{}) DisableAutoConvertInput() interface{} DisableSnowflakeData() interface{} SetDisableSnowflakeData(val interface{}) DisableSnowflakeDataInput() interface{} EmptyFieldAsNull() interface{} SetEmptyFieldAsNull(val interface{}) EmptyFieldAsNullInput() interface{} EnableOctal() interface{} SetEnableOctal(val interface{}) EnableOctalInput() interface{} Encoding() *string SetEncoding(val *string) EncodingInput() *string ErrorOnColumnCountMismatch() interface{} SetErrorOnColumnCountMismatch(val interface{}) ErrorOnColumnCountMismatchInput() interface{} Escape() *string SetEscape(val *string) EscapeInput() *string EscapeUnenclosedField() *string SetEscapeUnenclosedField(val *string) EscapeUnenclosedFieldInput() *string FieldDelimiter() *string SetFieldDelimiter(val *string) FieldDelimiterInput() *string FieldOptionallyEnclosedBy() *string SetFieldOptionallyEnclosedBy(val *string) FieldOptionallyEnclosedByInput() *string FileExtension() *string SetFileExtension(val *string) FileExtensionInput() *string // Experimental. ForEach() cdktf.ITerraformIterator // Experimental. SetForEach(val cdktf.ITerraformIterator) FormatType() *string SetFormatType(val *string) FormatTypeInput() *string // Experimental. Fqn() *string // Experimental. FriendlyUniqueId() *string Id() *string SetId(val *string) IdInput() *string IgnoreUtf8Errors() interface{} SetIgnoreUtf8Errors(val interface{}) IgnoreUtf8ErrorsInput() interface{} // Experimental. Lifecycle() *cdktf.TerraformResourceLifecycle // Experimental. SetLifecycle(val *cdktf.TerraformResourceLifecycle) Name() *string SetName(val *string) NameInput() *string // The tree node. Node() constructs.Node NullIf() *[]*string SetNullIf(val *[]*string) NullIfInput() *[]*string ParseHeader() interface{} SetParseHeader(val interface{}) ParseHeaderInput() interface{} PreserveSpace() interface{} SetPreserveSpace(val interface{}) PreserveSpaceInput() interface{} // Experimental. Provider() cdktf.TerraformProvider // Experimental. SetProvider(val cdktf.TerraformProvider) // Experimental. Provisioners() *[]interface{} // Experimental. SetProvisioners(val *[]interface{}) // Experimental. RawOverrides() interface{} RecordDelimiter() *string SetRecordDelimiter(val *string) RecordDelimiterInput() *string ReplaceInvalidCharacters() interface{} SetReplaceInvalidCharacters(val interface{}) ReplaceInvalidCharactersInput() interface{} Schema() *string SetSchema(val *string) SchemaInput() *string SkipBlankLines() interface{} SetSkipBlankLines(val interface{}) SkipBlankLinesInput() interface{} SkipByteOrderMark() interface{} SetSkipByteOrderMark(val interface{}) SkipByteOrderMarkInput() interface{} SkipHeader() *float64 SetSkipHeader(val *float64) SkipHeaderInput() *float64 StripNullValues() interface{} SetStripNullValues(val interface{}) StripNullValuesInput() interface{} StripOuterArray() interface{} SetStripOuterArray(val interface{}) StripOuterArrayInput() interface{} StripOuterElement() interface{} SetStripOuterElement(val interface{}) StripOuterElementInput() interface{} // Experimental. TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata // Experimental. TerraformMetaArguments() *map[string]interface{} // Experimental. TerraformResourceType() *string TimeFormat() *string SetTimeFormat(val *string) TimeFormatInput() *string TimestampFormat() *string SetTimestampFormat(val *string) TimestampFormatInput() *string TrimSpace() interface{} SetTrimSpace(val interface{}) TrimSpaceInput() interface{} // Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. // Experimental. AddMoveTarget(moveTarget *string) // Experimental. AddOverride(path *string, value interface{}) // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. HasResourceMove() interface{} // Experimental. ImportFrom(id *string, provider cdktf.TerraformProvider) // Experimental. InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable // 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. // Experimental. MoveFromId(id *string) // Moves this resource to the target resource given by moveTarget. // Experimental. MoveTo(moveTarget *string, index interface{}) // Moves this resource to the resource corresponding to "id". // Experimental. MoveToId(id *string) // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) ResetAllowDuplicate() ResetBinaryAsText() ResetBinaryFormat() ResetComment() ResetCompression() ResetDateFormat() ResetDisableAutoConvert() ResetDisableSnowflakeData() ResetEmptyFieldAsNull() ResetEnableOctal() ResetEncoding() ResetErrorOnColumnCountMismatch() ResetEscape() ResetEscapeUnenclosedField() ResetFieldDelimiter() ResetFieldOptionallyEnclosedBy() ResetFileExtension() ResetId() ResetIgnoreUtf8Errors() ResetNullIf() // Resets a previously passed logical Id to use the auto-generated logical id again. // Experimental. ResetOverrideLogicalId() ResetParseHeader() ResetPreserveSpace() ResetRecordDelimiter() ResetReplaceInvalidCharacters() ResetSkipBlankLines() ResetSkipByteOrderMark() ResetSkipHeader() ResetStripNullValues() ResetStripOuterArray() ResetStripOuterElement() ResetTimeFormat() ResetTimestampFormat() ResetTrimSpace() SynthesizeAttributes() *map[string]interface{} SynthesizeHclAttributes() *map[string]interface{} // Experimental. ToHclTerraform() interface{} // Experimental. ToMetadata() interface{} // Returns a string representation of this construct. ToString() *string // Adds this resource to the terraform JSON output. // Experimental. ToTerraform() interface{} }
Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format snowflake_file_format}.
func NewFileFormat ¶
func NewFileFormat(scope constructs.Construct, id *string, config *FileFormatConfig) FileFormat
Create a new {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format snowflake_file_format} Resource.
type FileFormatConfig ¶
type FileFormatConfig struct { // Experimental. Connection interface{} `field:"optional" json:"connection" yaml:"connection"` // Experimental. Count interface{} `field:"optional" json:"count" yaml:"count"` // Experimental. DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"` // Experimental. ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"` // Experimental. Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"` // Experimental. Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"` // Experimental. Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"` // The database in which to create the file format. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#database FileFormat#database} Database *string `field:"required" json:"database" yaml:"database"` // 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/0.94.0/docs/resources/file_format#format_type FileFormat#format_type} FormatType *string `field:"required" json:"formatType" yaml:"formatType"` // 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/0.94.0/docs/resources/file_format#name FileFormat#name} Name *string `field:"required" json:"name" yaml:"name"` // The schema in which to create the file format. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#schema FileFormat#schema} Schema *string `field:"required" json:"schema" yaml:"schema"` // 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/0.94.0/docs/resources/file_format#allow_duplicate FileFormat#allow_duplicate} AllowDuplicate interface{} `field:"optional" json:"allowDuplicate" yaml:"allowDuplicate"` // 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/0.94.0/docs/resources/file_format#binary_as_text FileFormat#binary_as_text} BinaryAsText interface{} `field:"optional" json:"binaryAsText" yaml:"binaryAsText"` // Defines the encoding format for binary input or output. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#binary_format FileFormat#binary_format} BinaryFormat *string `field:"optional" json:"binaryFormat" yaml:"binaryFormat"` // Specifies a comment for the file format. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#comment FileFormat#comment} Comment *string `field:"optional" json:"comment" yaml:"comment"` // Specifies the current compression algorithm for the data file. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#compression FileFormat#compression} Compression *string `field:"optional" json:"compression" yaml:"compression"` // 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/0.94.0/docs/resources/file_format#date_format FileFormat#date_format} DateFormat *string `field:"optional" json:"dateFormat" yaml:"dateFormat"` // 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/0.94.0/docs/resources/file_format#disable_auto_convert FileFormat#disable_auto_convert} DisableAutoConvert interface{} `field:"optional" json:"disableAutoConvert" yaml:"disableAutoConvert"` // 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/0.94.0/docs/resources/file_format#disable_snowflake_data FileFormat#disable_snowflake_data} DisableSnowflakeData interface{} `field:"optional" json:"disableSnowflakeData" yaml:"disableSnowflakeData"` // 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/0.94.0/docs/resources/file_format#empty_field_as_null FileFormat#empty_field_as_null} EmptyFieldAsNull interface{} `field:"optional" json:"emptyFieldAsNull" yaml:"emptyFieldAsNull"` // Boolean that enables parsing of octal numbers. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#enable_octal FileFormat#enable_octal} EnableOctal interface{} `field:"optional" json:"enableOctal" yaml:"enableOctal"` // 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/0.94.0/docs/resources/file_format#encoding FileFormat#encoding} Encoding *string `field:"optional" json:"encoding" yaml:"encoding"` // 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/0.94.0/docs/resources/file_format#error_on_column_count_mismatch FileFormat#error_on_column_count_mismatch} ErrorOnColumnCountMismatch interface{} `field:"optional" json:"errorOnColumnCountMismatch" yaml:"errorOnColumnCountMismatch"` // Single character string used as the escape character for field values. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#escape FileFormat#escape} Escape *string `field:"optional" json:"escape" yaml:"escape"` // 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/0.94.0/docs/resources/file_format#escape_unenclosed_field FileFormat#escape_unenclosed_field} EscapeUnenclosedField *string `field:"optional" json:"escapeUnenclosedField" yaml:"escapeUnenclosedField"` // 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/0.94.0/docs/resources/file_format#field_delimiter FileFormat#field_delimiter} FieldDelimiter *string `field:"optional" json:"fieldDelimiter" yaml:"fieldDelimiter"` // Character used to enclose strings. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#field_optionally_enclosed_by FileFormat#field_optionally_enclosed_by} FieldOptionallyEnclosedBy *string `field:"optional" json:"fieldOptionallyEnclosedBy" yaml:"fieldOptionallyEnclosedBy"` // Specifies the extension for files unloaded to a stage. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#file_extension FileFormat#file_extension} FileExtension *string `field:"optional" json:"fileExtension" yaml:"fileExtension"` // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/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. Id *string `field:"optional" json:"id" yaml:"id"` // Boolean that specifies whether UTF-8 encoding errors produce error conditions. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#ignore_utf8_errors FileFormat#ignore_utf8_errors} IgnoreUtf8Errors interface{} `field:"optional" json:"ignoreUtf8Errors" yaml:"ignoreUtf8Errors"` // String used to convert to and from SQL NULL. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#null_if FileFormat#null_if} NullIf *[]*string `field:"optional" json:"nullIf" yaml:"nullIf"` // 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/0.94.0/docs/resources/file_format#parse_header FileFormat#parse_header} ParseHeader interface{} `field:"optional" json:"parseHeader" yaml:"parseHeader"` // 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/0.94.0/docs/resources/file_format#preserve_space FileFormat#preserve_space} PreserveSpace interface{} `field:"optional" json:"preserveSpace" yaml:"preserveSpace"` // 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/0.94.0/docs/resources/file_format#record_delimiter FileFormat#record_delimiter} RecordDelimiter *string `field:"optional" json:"recordDelimiter" yaml:"recordDelimiter"` // 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/0.94.0/docs/resources/file_format#replace_invalid_characters FileFormat#replace_invalid_characters} ReplaceInvalidCharacters interface{} `field:"optional" json:"replaceInvalidCharacters" yaml:"replaceInvalidCharacters"` // 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/0.94.0/docs/resources/file_format#skip_blank_lines FileFormat#skip_blank_lines} SkipBlankLines interface{} `field:"optional" json:"skipBlankLines" yaml:"skipBlankLines"` // 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/0.94.0/docs/resources/file_format#skip_byte_order_mark FileFormat#skip_byte_order_mark} SkipByteOrderMark interface{} `field:"optional" json:"skipByteOrderMark" yaml:"skipByteOrderMark"` // Number of lines at the start of the file to skip. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#skip_header FileFormat#skip_header} SkipHeader *float64 `field:"optional" json:"skipHeader" yaml:"skipHeader"` // 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/0.94.0/docs/resources/file_format#strip_null_values FileFormat#strip_null_values} StripNullValues interface{} `field:"optional" json:"stripNullValues" yaml:"stripNullValues"` // Boolean that instructs the JSON parser to remove outer brackets. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#strip_outer_array FileFormat#strip_outer_array} StripOuterArray interface{} `field:"optional" json:"stripOuterArray" yaml:"stripOuterArray"` // 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/0.94.0/docs/resources/file_format#strip_outer_element FileFormat#strip_outer_element} StripOuterElement interface{} `field:"optional" json:"stripOuterElement" yaml:"stripOuterElement"` // 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/0.94.0/docs/resources/file_format#time_format FileFormat#time_format} TimeFormat *string `field:"optional" json:"timeFormat" yaml:"timeFormat"` // 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/0.94.0/docs/resources/file_format#timestamp_format FileFormat#timestamp_format} TimestampFormat *string `field:"optional" json:"timestampFormat" yaml:"timestampFormat"` // Boolean that specifies whether to remove white space from fields. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.94.0/docs/resources/file_format#trim_space FileFormat#trim_space} TrimSpace interface{} `field:"optional" json:"trimSpace" yaml:"trimSpace"` }