!> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.
Note Temporary stages are not supported because they result in per-session objects.
Note External changes detection on
credentials, andencryptionfields are not supported because Snowflake does not return such settings in DESCRIBE or SHOW STAGE output.
Note Due to Snowflake limitations, when
directory.auto_refreshis set to a new value in the configuration, the resource is recreated. When it is unset, the provider alters the wholedirectoryfield with theenablevalue from the configuration.
Note Integration based stages are not allowed to be altered to use privatelink endpoint. You must either alter the storage integration itself, or first unset the storage integration from the stage instead.
Note This resource is meant only for S3 stages, not S3-compatible stages. For S3-compatible stages, use the
snowflake.StageExternalS3Compatibleresource instead. Do not use this resource withs3compat://URLs.
Resource used to manage external S3 stages. For more information, check external stage documentation.
Example Usage
Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";
// Basic resource with storage integration
const basic = new snowflake.StageExternalS3("basic", {
name: "my_s3_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
});
// Complete resource with all options
const complete = new snowflake.StageExternalS3("complete", {
name: "complete_s3_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
storageIntegration: s3.name,
awsAccessPointArn: "arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point",
encryption: {
awsCse: {
masterKey: s3MasterKey,
},
},
directory: {
enable: true,
refreshOnCreate: "true",
autoRefresh: "false",
},
comment: "Fully configured S3 external stage",
});
// Resource with AWS key credentials instead of storage integration
const withKeyCredentials = new snowflake.StageExternalS3("with_key_credentials", {
name: "s3_stage_with_keys",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
credentials: {
awsKeyId: awsAccessKeyId,
awsSecretKey: awsSecretAccessKey,
awsToken: awsToken,
},
});
// Resource with AWS IAM role credentials
const withRoleCredentials = new snowflake.StageExternalS3("with_role_credentials", {
name: "s3_stage_with_role",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
credentials: {
awsRole: awsRoleArn,
},
});
// Resource with SSE-S3 encryption
const sseS3 = new snowflake.StageExternalS3("sse_s3", {
name: "s3_stage_sse_s3",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
storageIntegration: s3.name,
encryption: {
awsSseS3: {},
},
});
// Resource with SSE-KMS encryption
const sseKms = new snowflake.StageExternalS3("sse_kms", {
name: "s3_stage_sse_kms",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
storageIntegration: s3.name,
encryption: {
awsSseKms: {
kmsKeyId: kmsKeyId,
},
},
});
// Resource with encryption set to none
const noEncryption = new snowflake.StageExternalS3("no_encryption", {
name: "s3_stage_no_encryption",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
storageIntegration: s3.name,
encryption: {
none: {},
},
});
// resource with inline CSV file format
const withCsvFormat = new snowflake.StageExternalS3("with_csv_format", {
name: "s3_csv_format_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
fileFormat: {
csv: {
compression: "GZIP",
recordDelimiter: "\n",
fieldDelimiter: "|",
multiLine: "false",
fileExtension: ".csv",
skipHeader: 1,
skipBlankLines: "true",
dateFormat: "AUTO",
timeFormat: "AUTO",
timestampFormat: "AUTO",
binaryFormat: "HEX",
escape: "\\",
escapeUnenclosedField: "\\",
trimSpace: "false",
fieldOptionallyEnclosedBy: "\"",
nullIfs: [
"NULL",
"",
],
errorOnColumnCountMismatch: "true",
replaceInvalidCharacters: "false",
emptyFieldAsNull: "true",
skipByteOrderMark: "true",
encoding: "UTF8",
},
},
});
// resource with inline JSON file format
const withJsonFormat = new snowflake.StageExternalS3("with_json_format", {
name: "s3_json_format_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
fileFormat: {
json: {
compression: "AUTO",
dateFormat: "AUTO",
timeFormat: "AUTO",
timestampFormat: "AUTO",
binaryFormat: "HEX",
trimSpace: "false",
multiLine: "false",
nullIfs: [
"NULL",
"",
],
fileExtension: ".json",
enableOctal: "false",
allowDuplicate: "false",
stripOuterArray: "false",
stripNullValues: "false",
replaceInvalidCharacters: "false",
skipByteOrderMark: "false",
},
},
});
// resource with inline AVRO file format
const withAvroFormat = new snowflake.StageExternalS3("with_avro_format", {
name: "s3_avro_format_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
fileFormat: {
avro: {
compression: "GZIP",
trimSpace: "false",
replaceInvalidCharacters: "false",
nullIfs: [
"NULL",
"",
],
},
},
});
// resource with inline ORC file format
const withOrcFormat = new snowflake.StageExternalS3("with_orc_format", {
name: "s3_orc_format_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
fileFormat: {
orc: {
trimSpace: "false",
replaceInvalidCharacters: "false",
nullIfs: [
"NULL",
"",
],
},
},
});
// resource with inline Parquet file format
const withParquetFormat = new snowflake.StageExternalS3("with_parquet_format", {
name: "s3_parquet_format_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
fileFormat: {
parquet: {
compression: "SNAPPY",
binaryAsText: "true",
useLogicalType: "true",
trimSpace: "false",
useVectorizedScanner: "false",
replaceInvalidCharacters: "false",
nullIfs: [
"NULL",
"",
],
},
},
});
// resource with inline XML file format
const withXmlFormat = new snowflake.StageExternalS3("with_xml_format", {
name: "s3_xml_format_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
fileFormat: {
xml: {
compression: "AUTO",
preserveSpace: "false",
stripOuterElement: "false",
disableAutoConvert: "false",
replaceInvalidCharacters: "false",
skipByteOrderMark: "false",
},
},
});
// resource with named file format
const withNamedFormat = new snowflake.StageExternalS3("with_named_format", {
name: "s3_named_format_stage",
database: "my_database",
schema: "my_schema",
url: "s3://mybucket/mypath/",
fileFormat: {
formatName: test.fullyQualifiedName,
},
});
import pulumi
import pulumi_snowflake as snowflake
# Basic resource with storage integration
basic = snowflake.StageExternalS3("basic",
name="my_s3_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/")
# Complete resource with all options
complete = snowflake.StageExternalS3("complete",
name="complete_s3_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
storage_integration=s3["name"],
aws_access_point_arn="arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point",
encryption={
"aws_cse": {
"master_key": s3_master_key,
},
},
directory={
"enable": True,
"refresh_on_create": "true",
"auto_refresh": "false",
},
comment="Fully configured S3 external stage")
# Resource with AWS key credentials instead of storage integration
with_key_credentials = snowflake.StageExternalS3("with_key_credentials",
name="s3_stage_with_keys",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
credentials={
"aws_key_id": aws_access_key_id,
"aws_secret_key": aws_secret_access_key,
"aws_token": aws_token,
})
# Resource with AWS IAM role credentials
with_role_credentials = snowflake.StageExternalS3("with_role_credentials",
name="s3_stage_with_role",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
credentials={
"aws_role": aws_role_arn,
})
# Resource with SSE-S3 encryption
sse_s3 = snowflake.StageExternalS3("sse_s3",
name="s3_stage_sse_s3",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
storage_integration=s3["name"],
encryption={
"aws_sse_s3": {},
})
# Resource with SSE-KMS encryption
sse_kms = snowflake.StageExternalS3("sse_kms",
name="s3_stage_sse_kms",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
storage_integration=s3["name"],
encryption={
"aws_sse_kms": {
"kms_key_id": kms_key_id,
},
})
# Resource with encryption set to none
no_encryption = snowflake.StageExternalS3("no_encryption",
name="s3_stage_no_encryption",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
storage_integration=s3["name"],
encryption={
"none": {},
})
# resource with inline CSV file format
with_csv_format = snowflake.StageExternalS3("with_csv_format",
name="s3_csv_format_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
file_format={
"csv": {
"compression": "GZIP",
"record_delimiter": "\n",
"field_delimiter": "|",
"multi_line": "false",
"file_extension": ".csv",
"skip_header": 1,
"skip_blank_lines": "true",
"date_format": "AUTO",
"time_format": "AUTO",
"timestamp_format": "AUTO",
"binary_format": "HEX",
"escape": "\\",
"escape_unenclosed_field": "\\",
"trim_space": "false",
"field_optionally_enclosed_by": "\"",
"null_ifs": [
"NULL",
"",
],
"error_on_column_count_mismatch": "true",
"replace_invalid_characters": "false",
"empty_field_as_null": "true",
"skip_byte_order_mark": "true",
"encoding": "UTF8",
},
})
# resource with inline JSON file format
with_json_format = snowflake.StageExternalS3("with_json_format",
name="s3_json_format_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
file_format={
"json": {
"compression": "AUTO",
"date_format": "AUTO",
"time_format": "AUTO",
"timestamp_format": "AUTO",
"binary_format": "HEX",
"trim_space": "false",
"multi_line": "false",
"null_ifs": [
"NULL",
"",
],
"file_extension": ".json",
"enable_octal": "false",
"allow_duplicate": "false",
"strip_outer_array": "false",
"strip_null_values": "false",
"replace_invalid_characters": "false",
"skip_byte_order_mark": "false",
},
})
# resource with inline AVRO file format
with_avro_format = snowflake.StageExternalS3("with_avro_format",
name="s3_avro_format_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
file_format={
"avro": {
"compression": "GZIP",
"trim_space": "false",
"replace_invalid_characters": "false",
"null_ifs": [
"NULL",
"",
],
},
})
# resource with inline ORC file format
with_orc_format = snowflake.StageExternalS3("with_orc_format",
name="s3_orc_format_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
file_format={
"orc": {
"trim_space": "false",
"replace_invalid_characters": "false",
"null_ifs": [
"NULL",
"",
],
},
})
# resource with inline Parquet file format
with_parquet_format = snowflake.StageExternalS3("with_parquet_format",
name="s3_parquet_format_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
file_format={
"parquet": {
"compression": "SNAPPY",
"binary_as_text": "true",
"use_logical_type": "true",
"trim_space": "false",
"use_vectorized_scanner": "false",
"replace_invalid_characters": "false",
"null_ifs": [
"NULL",
"",
],
},
})
# resource with inline XML file format
with_xml_format = snowflake.StageExternalS3("with_xml_format",
name="s3_xml_format_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
file_format={
"xml": {
"compression": "AUTO",
"preserve_space": "false",
"strip_outer_element": "false",
"disable_auto_convert": "false",
"replace_invalid_characters": "false",
"skip_byte_order_mark": "false",
},
})
# resource with named file format
with_named_format = snowflake.StageExternalS3("with_named_format",
name="s3_named_format_stage",
database="my_database",
schema="my_schema",
url="s3://mybucket/mypath/",
file_format={
"format_name": test["fullyQualifiedName"],
})
package main
import (
"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Basic resource with storage integration
_, err := snowflake.NewStageExternalS3(ctx, "basic", &snowflake.StageExternalS3Args{
Name: pulumi.String("my_s3_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
})
if err != nil {
return err
}
// Complete resource with all options
_, err = snowflake.NewStageExternalS3(ctx, "complete", &snowflake.StageExternalS3Args{
Name: pulumi.String("complete_s3_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
StorageIntegration: pulumi.Any(s3.Name),
AwsAccessPointArn: pulumi.String("arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point"),
Encryption: &snowflake.StageExternalS3EncryptionArgs{
AwsCse: &snowflake.StageExternalS3EncryptionAwsCseArgs{
MasterKey: pulumi.Any(s3MasterKey),
},
},
Directory: &snowflake.StageExternalS3DirectoryArgs{
Enable: pulumi.Bool(true),
RefreshOnCreate: pulumi.String("true"),
AutoRefresh: pulumi.String("false"),
},
Comment: pulumi.String("Fully configured S3 external stage"),
})
if err != nil {
return err
}
// Resource with AWS key credentials instead of storage integration
_, err = snowflake.NewStageExternalS3(ctx, "with_key_credentials", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_stage_with_keys"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
Credentials: &snowflake.StageExternalS3CredentialsArgs{
AwsKeyId: pulumi.Any(awsAccessKeyId),
AwsSecretKey: pulumi.Any(awsSecretAccessKey),
AwsToken: pulumi.Any(awsToken),
},
})
if err != nil {
return err
}
// Resource with AWS IAM role credentials
_, err = snowflake.NewStageExternalS3(ctx, "with_role_credentials", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_stage_with_role"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
Credentials: &snowflake.StageExternalS3CredentialsArgs{
AwsRole: pulumi.Any(awsRoleArn),
},
})
if err != nil {
return err
}
// Resource with SSE-S3 encryption
_, err = snowflake.NewStageExternalS3(ctx, "sse_s3", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_stage_sse_s3"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
StorageIntegration: pulumi.Any(s3.Name),
Encryption: &snowflake.StageExternalS3EncryptionArgs{
AwsSseS3: &snowflake.StageExternalS3EncryptionAwsSseS3Args{},
},
})
if err != nil {
return err
}
// Resource with SSE-KMS encryption
_, err = snowflake.NewStageExternalS3(ctx, "sse_kms", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_stage_sse_kms"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
StorageIntegration: pulumi.Any(s3.Name),
Encryption: &snowflake.StageExternalS3EncryptionArgs{
AwsSseKms: &snowflake.StageExternalS3EncryptionAwsSseKmsArgs{
KmsKeyId: pulumi.Any(kmsKeyId),
},
},
})
if err != nil {
return err
}
// Resource with encryption set to none
_, err = snowflake.NewStageExternalS3(ctx, "no_encryption", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_stage_no_encryption"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
StorageIntegration: pulumi.Any(s3.Name),
Encryption: &snowflake.StageExternalS3EncryptionArgs{
None: &snowflake.StageExternalS3EncryptionNoneArgs{},
},
})
if err != nil {
return err
}
// resource with inline CSV file format
_, err = snowflake.NewStageExternalS3(ctx, "with_csv_format", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_csv_format_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
Csv: &snowflake.StageExternalS3FileFormatCsvArgs{
Compression: pulumi.String("GZIP"),
RecordDelimiter: pulumi.String("\n"),
FieldDelimiter: pulumi.String("|"),
MultiLine: pulumi.String("false"),
FileExtension: pulumi.String(".csv"),
SkipHeader: pulumi.Int(1),
SkipBlankLines: pulumi.String("true"),
DateFormat: pulumi.String("AUTO"),
TimeFormat: pulumi.String("AUTO"),
TimestampFormat: pulumi.String("AUTO"),
BinaryFormat: pulumi.String("HEX"),
Escape: pulumi.String("\\"),
EscapeUnenclosedField: pulumi.String("\\"),
TrimSpace: pulumi.String("false"),
FieldOptionallyEnclosedBy: pulumi.String("\""),
NullIfs: pulumi.StringArray{
pulumi.String("NULL"),
pulumi.String(""),
},
ErrorOnColumnCountMismatch: pulumi.String("true"),
ReplaceInvalidCharacters: pulumi.String("false"),
EmptyFieldAsNull: pulumi.String("true"),
SkipByteOrderMark: pulumi.String("true"),
Encoding: pulumi.String("UTF8"),
},
},
})
if err != nil {
return err
}
// resource with inline JSON file format
_, err = snowflake.NewStageExternalS3(ctx, "with_json_format", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_json_format_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
Json: &snowflake.StageExternalS3FileFormatJsonArgs{
Compression: pulumi.String("AUTO"),
DateFormat: pulumi.String("AUTO"),
TimeFormat: pulumi.String("AUTO"),
TimestampFormat: pulumi.String("AUTO"),
BinaryFormat: pulumi.String("HEX"),
TrimSpace: pulumi.String("false"),
MultiLine: pulumi.String("false"),
NullIfs: pulumi.StringArray{
pulumi.String("NULL"),
pulumi.String(""),
},
FileExtension: pulumi.String(".json"),
EnableOctal: pulumi.String("false"),
AllowDuplicate: pulumi.String("false"),
StripOuterArray: pulumi.String("false"),
StripNullValues: pulumi.String("false"),
ReplaceInvalidCharacters: pulumi.String("false"),
SkipByteOrderMark: pulumi.String("false"),
},
},
})
if err != nil {
return err
}
// resource with inline AVRO file format
_, err = snowflake.NewStageExternalS3(ctx, "with_avro_format", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_avro_format_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
Avro: &snowflake.StageExternalS3FileFormatAvroArgs{
Compression: pulumi.String("GZIP"),
TrimSpace: pulumi.String("false"),
ReplaceInvalidCharacters: pulumi.String("false"),
NullIfs: pulumi.StringArray{
pulumi.String("NULL"),
pulumi.String(""),
},
},
},
})
if err != nil {
return err
}
// resource with inline ORC file format
_, err = snowflake.NewStageExternalS3(ctx, "with_orc_format", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_orc_format_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
Orc: &snowflake.StageExternalS3FileFormatOrcArgs{
TrimSpace: pulumi.String("false"),
ReplaceInvalidCharacters: pulumi.String("false"),
NullIfs: pulumi.StringArray{
pulumi.String("NULL"),
pulumi.String(""),
},
},
},
})
if err != nil {
return err
}
// resource with inline Parquet file format
_, err = snowflake.NewStageExternalS3(ctx, "with_parquet_format", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_parquet_format_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
Parquet: &snowflake.StageExternalS3FileFormatParquetArgs{
Compression: pulumi.String("SNAPPY"),
BinaryAsText: pulumi.String("true"),
UseLogicalType: pulumi.String("true"),
TrimSpace: pulumi.String("false"),
UseVectorizedScanner: pulumi.String("false"),
ReplaceInvalidCharacters: pulumi.String("false"),
NullIfs: pulumi.StringArray{
pulumi.String("NULL"),
pulumi.String(""),
},
},
},
})
if err != nil {
return err
}
// resource with inline XML file format
_, err = snowflake.NewStageExternalS3(ctx, "with_xml_format", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_xml_format_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
Xml: &snowflake.StageExternalS3FileFormatXmlArgs{
Compression: pulumi.String("AUTO"),
PreserveSpace: pulumi.String("false"),
StripOuterElement: pulumi.String("false"),
DisableAutoConvert: pulumi.String("false"),
ReplaceInvalidCharacters: pulumi.String("false"),
SkipByteOrderMark: pulumi.String("false"),
},
},
})
if err != nil {
return err
}
// resource with named file format
_, err = snowflake.NewStageExternalS3(ctx, "with_named_format", &snowflake.StageExternalS3Args{
Name: pulumi.String("s3_named_format_stage"),
Database: pulumi.String("my_database"),
Schema: pulumi.String("my_schema"),
Url: pulumi.String("s3://mybucket/mypath/"),
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
FormatName: pulumi.Any(test.FullyQualifiedName),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;
return await Deployment.RunAsync(() =>
{
// Basic resource with storage integration
var basic = new Snowflake.StageExternalS3("basic", new()
{
Name = "my_s3_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
});
// Complete resource with all options
var complete = new Snowflake.StageExternalS3("complete", new()
{
Name = "complete_s3_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
StorageIntegration = s3.Name,
AwsAccessPointArn = "arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point",
Encryption = new Snowflake.Inputs.StageExternalS3EncryptionArgs
{
AwsCse = new Snowflake.Inputs.StageExternalS3EncryptionAwsCseArgs
{
MasterKey = s3MasterKey,
},
},
Directory = new Snowflake.Inputs.StageExternalS3DirectoryArgs
{
Enable = true,
RefreshOnCreate = "true",
AutoRefresh = "false",
},
Comment = "Fully configured S3 external stage",
});
// Resource with AWS key credentials instead of storage integration
var withKeyCredentials = new Snowflake.StageExternalS3("with_key_credentials", new()
{
Name = "s3_stage_with_keys",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
Credentials = new Snowflake.Inputs.StageExternalS3CredentialsArgs
{
AwsKeyId = awsAccessKeyId,
AwsSecretKey = awsSecretAccessKey,
AwsToken = awsToken,
},
});
// Resource with AWS IAM role credentials
var withRoleCredentials = new Snowflake.StageExternalS3("with_role_credentials", new()
{
Name = "s3_stage_with_role",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
Credentials = new Snowflake.Inputs.StageExternalS3CredentialsArgs
{
AwsRole = awsRoleArn,
},
});
// Resource with SSE-S3 encryption
var sseS3 = new Snowflake.StageExternalS3("sse_s3", new()
{
Name = "s3_stage_sse_s3",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
StorageIntegration = s3.Name,
Encryption = new Snowflake.Inputs.StageExternalS3EncryptionArgs
{
AwsSseS3 = null,
},
});
// Resource with SSE-KMS encryption
var sseKms = new Snowflake.StageExternalS3("sse_kms", new()
{
Name = "s3_stage_sse_kms",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
StorageIntegration = s3.Name,
Encryption = new Snowflake.Inputs.StageExternalS3EncryptionArgs
{
AwsSseKms = new Snowflake.Inputs.StageExternalS3EncryptionAwsSseKmsArgs
{
KmsKeyId = kmsKeyId,
},
},
});
// Resource with encryption set to none
var noEncryption = new Snowflake.StageExternalS3("no_encryption", new()
{
Name = "s3_stage_no_encryption",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
StorageIntegration = s3.Name,
Encryption = new Snowflake.Inputs.StageExternalS3EncryptionArgs
{
None = null,
},
});
// resource with inline CSV file format
var withCsvFormat = new Snowflake.StageExternalS3("with_csv_format", new()
{
Name = "s3_csv_format_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
Csv = new Snowflake.Inputs.StageExternalS3FileFormatCsvArgs
{
Compression = "GZIP",
RecordDelimiter = @"
",
FieldDelimiter = "|",
MultiLine = "false",
FileExtension = ".csv",
SkipHeader = 1,
SkipBlankLines = "true",
DateFormat = "AUTO",
TimeFormat = "AUTO",
TimestampFormat = "AUTO",
BinaryFormat = "HEX",
Escape = "\\",
EscapeUnenclosedField = "\\",
TrimSpace = "false",
FieldOptionallyEnclosedBy = "\"",
NullIfs = new[]
{
"NULL",
"",
},
ErrorOnColumnCountMismatch = "true",
ReplaceInvalidCharacters = "false",
EmptyFieldAsNull = "true",
SkipByteOrderMark = "true",
Encoding = "UTF8",
},
},
});
// resource with inline JSON file format
var withJsonFormat = new Snowflake.StageExternalS3("with_json_format", new()
{
Name = "s3_json_format_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
Json = new Snowflake.Inputs.StageExternalS3FileFormatJsonArgs
{
Compression = "AUTO",
DateFormat = "AUTO",
TimeFormat = "AUTO",
TimestampFormat = "AUTO",
BinaryFormat = "HEX",
TrimSpace = "false",
MultiLine = "false",
NullIfs = new[]
{
"NULL",
"",
},
FileExtension = ".json",
EnableOctal = "false",
AllowDuplicate = "false",
StripOuterArray = "false",
StripNullValues = "false",
ReplaceInvalidCharacters = "false",
SkipByteOrderMark = "false",
},
},
});
// resource with inline AVRO file format
var withAvroFormat = new Snowflake.StageExternalS3("with_avro_format", new()
{
Name = "s3_avro_format_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
Avro = new Snowflake.Inputs.StageExternalS3FileFormatAvroArgs
{
Compression = "GZIP",
TrimSpace = "false",
ReplaceInvalidCharacters = "false",
NullIfs = new[]
{
"NULL",
"",
},
},
},
});
// resource with inline ORC file format
var withOrcFormat = new Snowflake.StageExternalS3("with_orc_format", new()
{
Name = "s3_orc_format_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
Orc = new Snowflake.Inputs.StageExternalS3FileFormatOrcArgs
{
TrimSpace = "false",
ReplaceInvalidCharacters = "false",
NullIfs = new[]
{
"NULL",
"",
},
},
},
});
// resource with inline Parquet file format
var withParquetFormat = new Snowflake.StageExternalS3("with_parquet_format", new()
{
Name = "s3_parquet_format_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
Parquet = new Snowflake.Inputs.StageExternalS3FileFormatParquetArgs
{
Compression = "SNAPPY",
BinaryAsText = "true",
UseLogicalType = "true",
TrimSpace = "false",
UseVectorizedScanner = "false",
ReplaceInvalidCharacters = "false",
NullIfs = new[]
{
"NULL",
"",
},
},
},
});
// resource with inline XML file format
var withXmlFormat = new Snowflake.StageExternalS3("with_xml_format", new()
{
Name = "s3_xml_format_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
Xml = new Snowflake.Inputs.StageExternalS3FileFormatXmlArgs
{
Compression = "AUTO",
PreserveSpace = "false",
StripOuterElement = "false",
DisableAutoConvert = "false",
ReplaceInvalidCharacters = "false",
SkipByteOrderMark = "false",
},
},
});
// resource with named file format
var withNamedFormat = new Snowflake.StageExternalS3("with_named_format", new()
{
Name = "s3_named_format_stage",
Database = "my_database",
Schema = "my_schema",
Url = "s3://mybucket/mypath/",
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
FormatName = test.FullyQualifiedName,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.StageExternalS3;
import com.pulumi.snowflake.StageExternalS3Args;
import com.pulumi.snowflake.inputs.StageExternalS3EncryptionArgs;
import com.pulumi.snowflake.inputs.StageExternalS3EncryptionAwsCseArgs;
import com.pulumi.snowflake.inputs.StageExternalS3DirectoryArgs;
import com.pulumi.snowflake.inputs.StageExternalS3CredentialsArgs;
import com.pulumi.snowflake.inputs.StageExternalS3EncryptionAwsSseS3Args;
import com.pulumi.snowflake.inputs.StageExternalS3EncryptionAwsSseKmsArgs;
import com.pulumi.snowflake.inputs.StageExternalS3EncryptionNoneArgs;
import com.pulumi.snowflake.inputs.StageExternalS3FileFormatArgs;
import com.pulumi.snowflake.inputs.StageExternalS3FileFormatCsvArgs;
import com.pulumi.snowflake.inputs.StageExternalS3FileFormatJsonArgs;
import com.pulumi.snowflake.inputs.StageExternalS3FileFormatAvroArgs;
import com.pulumi.snowflake.inputs.StageExternalS3FileFormatOrcArgs;
import com.pulumi.snowflake.inputs.StageExternalS3FileFormatParquetArgs;
import com.pulumi.snowflake.inputs.StageExternalS3FileFormatXmlArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Basic resource with storage integration
var basic = new StageExternalS3("basic", StageExternalS3Args.builder()
.name("my_s3_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.build());
// Complete resource with all options
var complete = new StageExternalS3("complete", StageExternalS3Args.builder()
.name("complete_s3_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.storageIntegration(s3.name())
.awsAccessPointArn("arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point")
.encryption(StageExternalS3EncryptionArgs.builder()
.awsCse(StageExternalS3EncryptionAwsCseArgs.builder()
.masterKey(s3MasterKey)
.build())
.build())
.directory(StageExternalS3DirectoryArgs.builder()
.enable(true)
.refreshOnCreate("true")
.autoRefresh("false")
.build())
.comment("Fully configured S3 external stage")
.build());
// Resource with AWS key credentials instead of storage integration
var withKeyCredentials = new StageExternalS3("withKeyCredentials", StageExternalS3Args.builder()
.name("s3_stage_with_keys")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.credentials(StageExternalS3CredentialsArgs.builder()
.awsKeyId(awsAccessKeyId)
.awsSecretKey(awsSecretAccessKey)
.awsToken(awsToken)
.build())
.build());
// Resource with AWS IAM role credentials
var withRoleCredentials = new StageExternalS3("withRoleCredentials", StageExternalS3Args.builder()
.name("s3_stage_with_role")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.credentials(StageExternalS3CredentialsArgs.builder()
.awsRole(awsRoleArn)
.build())
.build());
// Resource with SSE-S3 encryption
var sseS3 = new StageExternalS3("sseS3", StageExternalS3Args.builder()
.name("s3_stage_sse_s3")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.storageIntegration(s3.name())
.encryption(StageExternalS3EncryptionArgs.builder()
.awsSseS3(StageExternalS3EncryptionAwsSseS3Args.builder()
.build())
.build())
.build());
// Resource with SSE-KMS encryption
var sseKms = new StageExternalS3("sseKms", StageExternalS3Args.builder()
.name("s3_stage_sse_kms")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.storageIntegration(s3.name())
.encryption(StageExternalS3EncryptionArgs.builder()
.awsSseKms(StageExternalS3EncryptionAwsSseKmsArgs.builder()
.kmsKeyId(kmsKeyId)
.build())
.build())
.build());
// Resource with encryption set to none
var noEncryption = new StageExternalS3("noEncryption", StageExternalS3Args.builder()
.name("s3_stage_no_encryption")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.storageIntegration(s3.name())
.encryption(StageExternalS3EncryptionArgs.builder()
.none(StageExternalS3EncryptionNoneArgs.builder()
.build())
.build())
.build());
// resource with inline CSV file format
var withCsvFormat = new StageExternalS3("withCsvFormat", StageExternalS3Args.builder()
.name("s3_csv_format_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.fileFormat(StageExternalS3FileFormatArgs.builder()
.csv(StageExternalS3FileFormatCsvArgs.builder()
.compression("GZIP")
.recordDelimiter("""
""")
.fieldDelimiter("|")
.multiLine("false")
.fileExtension(".csv")
.skipHeader(1)
.skipBlankLines("true")
.dateFormat("AUTO")
.timeFormat("AUTO")
.timestampFormat("AUTO")
.binaryFormat("HEX")
.escape("\\")
.escapeUnenclosedField("\\")
.trimSpace("false")
.fieldOptionallyEnclosedBy("\"")
.nullIfs(
"NULL",
"")
.errorOnColumnCountMismatch("true")
.replaceInvalidCharacters("false")
.emptyFieldAsNull("true")
.skipByteOrderMark("true")
.encoding("UTF8")
.build())
.build())
.build());
// resource with inline JSON file format
var withJsonFormat = new StageExternalS3("withJsonFormat", StageExternalS3Args.builder()
.name("s3_json_format_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.fileFormat(StageExternalS3FileFormatArgs.builder()
.json(StageExternalS3FileFormatJsonArgs.builder()
.compression("AUTO")
.dateFormat("AUTO")
.timeFormat("AUTO")
.timestampFormat("AUTO")
.binaryFormat("HEX")
.trimSpace("false")
.multiLine("false")
.nullIfs(
"NULL",
"")
.fileExtension(".json")
.enableOctal("false")
.allowDuplicate("false")
.stripOuterArray("false")
.stripNullValues("false")
.replaceInvalidCharacters("false")
.skipByteOrderMark("false")
.build())
.build())
.build());
// resource with inline AVRO file format
var withAvroFormat = new StageExternalS3("withAvroFormat", StageExternalS3Args.builder()
.name("s3_avro_format_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.fileFormat(StageExternalS3FileFormatArgs.builder()
.avro(StageExternalS3FileFormatAvroArgs.builder()
.compression("GZIP")
.trimSpace("false")
.replaceInvalidCharacters("false")
.nullIfs(
"NULL",
"")
.build())
.build())
.build());
// resource with inline ORC file format
var withOrcFormat = new StageExternalS3("withOrcFormat", StageExternalS3Args.builder()
.name("s3_orc_format_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.fileFormat(StageExternalS3FileFormatArgs.builder()
.orc(StageExternalS3FileFormatOrcArgs.builder()
.trimSpace("false")
.replaceInvalidCharacters("false")
.nullIfs(
"NULL",
"")
.build())
.build())
.build());
// resource with inline Parquet file format
var withParquetFormat = new StageExternalS3("withParquetFormat", StageExternalS3Args.builder()
.name("s3_parquet_format_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.fileFormat(StageExternalS3FileFormatArgs.builder()
.parquet(StageExternalS3FileFormatParquetArgs.builder()
.compression("SNAPPY")
.binaryAsText("true")
.useLogicalType("true")
.trimSpace("false")
.useVectorizedScanner("false")
.replaceInvalidCharacters("false")
.nullIfs(
"NULL",
"")
.build())
.build())
.build());
// resource with inline XML file format
var withXmlFormat = new StageExternalS3("withXmlFormat", StageExternalS3Args.builder()
.name("s3_xml_format_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.fileFormat(StageExternalS3FileFormatArgs.builder()
.xml(StageExternalS3FileFormatXmlArgs.builder()
.compression("AUTO")
.preserveSpace("false")
.stripOuterElement("false")
.disableAutoConvert("false")
.replaceInvalidCharacters("false")
.skipByteOrderMark("false")
.build())
.build())
.build());
// resource with named file format
var withNamedFormat = new StageExternalS3("withNamedFormat", StageExternalS3Args.builder()
.name("s3_named_format_stage")
.database("my_database")
.schema("my_schema")
.url("s3://mybucket/mypath/")
.fileFormat(StageExternalS3FileFormatArgs.builder()
.formatName(test.fullyQualifiedName())
.build())
.build());
}
}
resources:
# Basic resource with storage integration
basic:
type: snowflake:StageExternalS3
properties:
name: my_s3_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
# Complete resource with all options
complete:
type: snowflake:StageExternalS3
properties:
name: complete_s3_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
storageIntegration: ${s3.name}
awsAccessPointArn: arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point
encryption:
awsCse:
masterKey: ${s3MasterKey}
directory:
enable: true
refreshOnCreate: true
autoRefresh: false
comment: Fully configured S3 external stage
# Resource with AWS key credentials instead of storage integration
withKeyCredentials:
type: snowflake:StageExternalS3
name: with_key_credentials
properties:
name: s3_stage_with_keys
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
credentials:
awsKeyId: ${awsAccessKeyId}
awsSecretKey: ${awsSecretAccessKey}
awsToken: ${awsToken}
# Resource with AWS IAM role credentials
withRoleCredentials:
type: snowflake:StageExternalS3
name: with_role_credentials
properties:
name: s3_stage_with_role
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
credentials:
awsRole: ${awsRoleArn}
# Resource with SSE-S3 encryption
sseS3:
type: snowflake:StageExternalS3
name: sse_s3
properties:
name: s3_stage_sse_s3
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
storageIntegration: ${s3.name}
encryption:
awsSseS3: {}
# Resource with SSE-KMS encryption
sseKms:
type: snowflake:StageExternalS3
name: sse_kms
properties:
name: s3_stage_sse_kms
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
storageIntegration: ${s3.name}
encryption:
awsSseKms:
kmsKeyId: ${kmsKeyId}
# Resource with encryption set to none
noEncryption:
type: snowflake:StageExternalS3
name: no_encryption
properties:
name: s3_stage_no_encryption
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
storageIntegration: ${s3.name}
encryption:
none: {}
# resource with inline CSV file format
withCsvFormat:
type: snowflake:StageExternalS3
name: with_csv_format
properties:
name: s3_csv_format_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
fileFormat:
csv:
compression: GZIP
recordDelimiter: |2+
fieldDelimiter: '|'
multiLine: 'false'
fileExtension: .csv
skipHeader: 1
skipBlankLines: 'true'
dateFormat: AUTO
timeFormat: AUTO
timestampFormat: AUTO
binaryFormat: HEX
escape: \
escapeUnenclosedField: \
trimSpace: 'false'
fieldOptionallyEnclosedBy: '"'
nullIfs:
- NULL
- ""
errorOnColumnCountMismatch: 'true'
replaceInvalidCharacters: 'false'
emptyFieldAsNull: 'true'
skipByteOrderMark: 'true'
encoding: UTF8
# resource with inline JSON file format
withJsonFormat:
type: snowflake:StageExternalS3
name: with_json_format
properties:
name: s3_json_format_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
fileFormat:
json:
compression: AUTO
dateFormat: AUTO
timeFormat: AUTO
timestampFormat: AUTO
binaryFormat: HEX
trimSpace: 'false'
multiLine: 'false'
nullIfs:
- NULL
- ""
fileExtension: .json
enableOctal: 'false'
allowDuplicate: 'false'
stripOuterArray: 'false'
stripNullValues: 'false'
replaceInvalidCharacters: 'false'
skipByteOrderMark: 'false'
# resource with inline AVRO file format
withAvroFormat:
type: snowflake:StageExternalS3
name: with_avro_format
properties:
name: s3_avro_format_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
fileFormat:
avro:
compression: GZIP
trimSpace: 'false'
replaceInvalidCharacters: 'false'
nullIfs:
- NULL
- ""
# resource with inline ORC file format
withOrcFormat:
type: snowflake:StageExternalS3
name: with_orc_format
properties:
name: s3_orc_format_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
fileFormat:
orc:
trimSpace: 'false'
replaceInvalidCharacters: 'false'
nullIfs:
- NULL
- ""
# resource with inline Parquet file format
withParquetFormat:
type: snowflake:StageExternalS3
name: with_parquet_format
properties:
name: s3_parquet_format_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
fileFormat:
parquet:
compression: SNAPPY
binaryAsText: 'true'
useLogicalType: 'true'
trimSpace: 'false'
useVectorizedScanner: 'false'
replaceInvalidCharacters: 'false'
nullIfs:
- NULL
- ""
# resource with inline XML file format
withXmlFormat:
type: snowflake:StageExternalS3
name: with_xml_format
properties:
name: s3_xml_format_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
fileFormat:
xml:
compression: AUTO
preserveSpace: 'false'
stripOuterElement: 'false'
disableAutoConvert: 'false'
replaceInvalidCharacters: 'false'
skipByteOrderMark: 'false'
# resource with named file format
withNamedFormat:
type: snowflake:StageExternalS3
name: with_named_format
properties:
name: s3_named_format_stage
database: my_database
schema: my_schema
url: s3://mybucket/mypath/
fileFormat:
formatName: ${test.fullyQualifiedName}
Note If a field has a default value, it is shown next to the type in the schema.
Create StageExternalS3 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new StageExternalS3(name: string, args: StageExternalS3Args, opts?: CustomResourceOptions);@overload
def StageExternalS3(resource_name: str,
args: StageExternalS3Args,
opts: Optional[ResourceOptions] = None)
@overload
def StageExternalS3(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
schema: Optional[str] = None,
url: Optional[str] = None,
aws_access_point_arn: Optional[str] = None,
comment: Optional[str] = None,
credentials: Optional[StageExternalS3CredentialsArgs] = None,
directory: Optional[StageExternalS3DirectoryArgs] = None,
encryption: Optional[StageExternalS3EncryptionArgs] = None,
file_format: Optional[StageExternalS3FileFormatArgs] = None,
name: Optional[str] = None,
storage_integration: Optional[str] = None,
use_privatelink_endpoint: Optional[str] = None)func NewStageExternalS3(ctx *Context, name string, args StageExternalS3Args, opts ...ResourceOption) (*StageExternalS3, error)public StageExternalS3(string name, StageExternalS3Args args, CustomResourceOptions? opts = null)
public StageExternalS3(String name, StageExternalS3Args args)
public StageExternalS3(String name, StageExternalS3Args args, CustomResourceOptions options)
type: snowflake:StageExternalS3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StageExternalS3Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StageExternalS3Args
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StageExternalS3Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StageExternalS3Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StageExternalS3Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var stageExternalS3Resource = new Snowflake.StageExternalS3("stageExternalS3Resource", new()
{
Database = "string",
Schema = "string",
Url = "string",
AwsAccessPointArn = "string",
Comment = "string",
Credentials = new Snowflake.Inputs.StageExternalS3CredentialsArgs
{
AwsKeyId = "string",
AwsRole = "string",
AwsSecretKey = "string",
AwsToken = "string",
},
Directory = new Snowflake.Inputs.StageExternalS3DirectoryArgs
{
Enable = false,
AutoRefresh = "string",
RefreshOnCreate = "string",
},
Encryption = new Snowflake.Inputs.StageExternalS3EncryptionArgs
{
AwsCse = new Snowflake.Inputs.StageExternalS3EncryptionAwsCseArgs
{
MasterKey = "string",
},
AwsSseKms = new Snowflake.Inputs.StageExternalS3EncryptionAwsSseKmsArgs
{
KmsKeyId = "string",
},
AwsSseS3 = null,
None = null,
},
FileFormat = new Snowflake.Inputs.StageExternalS3FileFormatArgs
{
Avro = new Snowflake.Inputs.StageExternalS3FileFormatAvroArgs
{
Compression = "string",
NullIfs = new[]
{
"string",
},
ReplaceInvalidCharacters = "string",
TrimSpace = "string",
},
Csv = new Snowflake.Inputs.StageExternalS3FileFormatCsvArgs
{
BinaryFormat = "string",
Compression = "string",
DateFormat = "string",
EmptyFieldAsNull = "string",
Encoding = "string",
ErrorOnColumnCountMismatch = "string",
Escape = "string",
EscapeUnenclosedField = "string",
FieldDelimiter = "string",
FieldOptionallyEnclosedBy = "string",
FileExtension = "string",
MultiLine = "string",
NullIfs = new[]
{
"string",
},
ParseHeader = "string",
RecordDelimiter = "string",
ReplaceInvalidCharacters = "string",
SkipBlankLines = "string",
SkipByteOrderMark = "string",
SkipHeader = 0,
TimeFormat = "string",
TimestampFormat = "string",
TrimSpace = "string",
},
FormatName = "string",
Json = new Snowflake.Inputs.StageExternalS3FileFormatJsonArgs
{
AllowDuplicate = "string",
BinaryFormat = "string",
Compression = "string",
DateFormat = "string",
EnableOctal = "string",
FileExtension = "string",
IgnoreUtf8Errors = "string",
MultiLine = "string",
NullIfs = new[]
{
"string",
},
ReplaceInvalidCharacters = "string",
SkipByteOrderMark = "string",
StripNullValues = "string",
StripOuterArray = "string",
TimeFormat = "string",
TimestampFormat = "string",
TrimSpace = "string",
},
Orc = new Snowflake.Inputs.StageExternalS3FileFormatOrcArgs
{
NullIfs = new[]
{
"string",
},
ReplaceInvalidCharacters = "string",
TrimSpace = "string",
},
Parquet = new Snowflake.Inputs.StageExternalS3FileFormatParquetArgs
{
BinaryAsText = "string",
Compression = "string",
NullIfs = new[]
{
"string",
},
ReplaceInvalidCharacters = "string",
TrimSpace = "string",
UseLogicalType = "string",
UseVectorizedScanner = "string",
},
Xml = new Snowflake.Inputs.StageExternalS3FileFormatXmlArgs
{
Compression = "string",
DisableAutoConvert = "string",
IgnoreUtf8Errors = "string",
PreserveSpace = "string",
ReplaceInvalidCharacters = "string",
SkipByteOrderMark = "string",
StripOuterElement = "string",
},
},
Name = "string",
StorageIntegration = "string",
UsePrivatelinkEndpoint = "string",
});
example, err := snowflake.NewStageExternalS3(ctx, "stageExternalS3Resource", &snowflake.StageExternalS3Args{
Database: pulumi.String("string"),
Schema: pulumi.String("string"),
Url: pulumi.String("string"),
AwsAccessPointArn: pulumi.String("string"),
Comment: pulumi.String("string"),
Credentials: &snowflake.StageExternalS3CredentialsArgs{
AwsKeyId: pulumi.String("string"),
AwsRole: pulumi.String("string"),
AwsSecretKey: pulumi.String("string"),
AwsToken: pulumi.String("string"),
},
Directory: &snowflake.StageExternalS3DirectoryArgs{
Enable: pulumi.Bool(false),
AutoRefresh: pulumi.String("string"),
RefreshOnCreate: pulumi.String("string"),
},
Encryption: &snowflake.StageExternalS3EncryptionArgs{
AwsCse: &snowflake.StageExternalS3EncryptionAwsCseArgs{
MasterKey: pulumi.String("string"),
},
AwsSseKms: &snowflake.StageExternalS3EncryptionAwsSseKmsArgs{
KmsKeyId: pulumi.String("string"),
},
AwsSseS3: &snowflake.StageExternalS3EncryptionAwsSseS3Args{},
None: &snowflake.StageExternalS3EncryptionNoneArgs{},
},
FileFormat: &snowflake.StageExternalS3FileFormatArgs{
Avro: &snowflake.StageExternalS3FileFormatAvroArgs{
Compression: pulumi.String("string"),
NullIfs: pulumi.StringArray{
pulumi.String("string"),
},
ReplaceInvalidCharacters: pulumi.String("string"),
TrimSpace: pulumi.String("string"),
},
Csv: &snowflake.StageExternalS3FileFormatCsvArgs{
BinaryFormat: pulumi.String("string"),
Compression: pulumi.String("string"),
DateFormat: pulumi.String("string"),
EmptyFieldAsNull: pulumi.String("string"),
Encoding: pulumi.String("string"),
ErrorOnColumnCountMismatch: pulumi.String("string"),
Escape: pulumi.String("string"),
EscapeUnenclosedField: pulumi.String("string"),
FieldDelimiter: pulumi.String("string"),
FieldOptionallyEnclosedBy: pulumi.String("string"),
FileExtension: pulumi.String("string"),
MultiLine: pulumi.String("string"),
NullIfs: pulumi.StringArray{
pulumi.String("string"),
},
ParseHeader: pulumi.String("string"),
RecordDelimiter: pulumi.String("string"),
ReplaceInvalidCharacters: pulumi.String("string"),
SkipBlankLines: pulumi.String("string"),
SkipByteOrderMark: pulumi.String("string"),
SkipHeader: pulumi.Int(0),
TimeFormat: pulumi.String("string"),
TimestampFormat: pulumi.String("string"),
TrimSpace: pulumi.String("string"),
},
FormatName: pulumi.String("string"),
Json: &snowflake.StageExternalS3FileFormatJsonArgs{
AllowDuplicate: pulumi.String("string"),
BinaryFormat: pulumi.String("string"),
Compression: pulumi.String("string"),
DateFormat: pulumi.String("string"),
EnableOctal: pulumi.String("string"),
FileExtension: pulumi.String("string"),
IgnoreUtf8Errors: pulumi.String("string"),
MultiLine: pulumi.String("string"),
NullIfs: pulumi.StringArray{
pulumi.String("string"),
},
ReplaceInvalidCharacters: pulumi.String("string"),
SkipByteOrderMark: pulumi.String("string"),
StripNullValues: pulumi.String("string"),
StripOuterArray: pulumi.String("string"),
TimeFormat: pulumi.String("string"),
TimestampFormat: pulumi.String("string"),
TrimSpace: pulumi.String("string"),
},
Orc: &snowflake.StageExternalS3FileFormatOrcArgs{
NullIfs: pulumi.StringArray{
pulumi.String("string"),
},
ReplaceInvalidCharacters: pulumi.String("string"),
TrimSpace: pulumi.String("string"),
},
Parquet: &snowflake.StageExternalS3FileFormatParquetArgs{
BinaryAsText: pulumi.String("string"),
Compression: pulumi.String("string"),
NullIfs: pulumi.StringArray{
pulumi.String("string"),
},
ReplaceInvalidCharacters: pulumi.String("string"),
TrimSpace: pulumi.String("string"),
UseLogicalType: pulumi.String("string"),
UseVectorizedScanner: pulumi.String("string"),
},
Xml: &snowflake.StageExternalS3FileFormatXmlArgs{
Compression: pulumi.String("string"),
DisableAutoConvert: pulumi.String("string"),
IgnoreUtf8Errors: pulumi.String("string"),
PreserveSpace: pulumi.String("string"),
ReplaceInvalidCharacters: pulumi.String("string"),
SkipByteOrderMark: pulumi.String("string"),
StripOuterElement: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
StorageIntegration: pulumi.String("string"),
UsePrivatelinkEndpoint: pulumi.String("string"),
})
var stageExternalS3Resource = new StageExternalS3("stageExternalS3Resource", StageExternalS3Args.builder()
.database("string")
.schema("string")
.url("string")
.awsAccessPointArn("string")
.comment("string")
.credentials(StageExternalS3CredentialsArgs.builder()
.awsKeyId("string")
.awsRole("string")
.awsSecretKey("string")
.awsToken("string")
.build())
.directory(StageExternalS3DirectoryArgs.builder()
.enable(false)
.autoRefresh("string")
.refreshOnCreate("string")
.build())
.encryption(StageExternalS3EncryptionArgs.builder()
.awsCse(StageExternalS3EncryptionAwsCseArgs.builder()
.masterKey("string")
.build())
.awsSseKms(StageExternalS3EncryptionAwsSseKmsArgs.builder()
.kmsKeyId("string")
.build())
.awsSseS3(StageExternalS3EncryptionAwsSseS3Args.builder()
.build())
.none(StageExternalS3EncryptionNoneArgs.builder()
.build())
.build())
.fileFormat(StageExternalS3FileFormatArgs.builder()
.avro(StageExternalS3FileFormatAvroArgs.builder()
.compression("string")
.nullIfs("string")
.replaceInvalidCharacters("string")
.trimSpace("string")
.build())
.csv(StageExternalS3FileFormatCsvArgs.builder()
.binaryFormat("string")
.compression("string")
.dateFormat("string")
.emptyFieldAsNull("string")
.encoding("string")
.errorOnColumnCountMismatch("string")
.escape("string")
.escapeUnenclosedField("string")
.fieldDelimiter("string")
.fieldOptionallyEnclosedBy("string")
.fileExtension("string")
.multiLine("string")
.nullIfs("string")
.parseHeader("string")
.recordDelimiter("string")
.replaceInvalidCharacters("string")
.skipBlankLines("string")
.skipByteOrderMark("string")
.skipHeader(0)
.timeFormat("string")
.timestampFormat("string")
.trimSpace("string")
.build())
.formatName("string")
.json(StageExternalS3FileFormatJsonArgs.builder()
.allowDuplicate("string")
.binaryFormat("string")
.compression("string")
.dateFormat("string")
.enableOctal("string")
.fileExtension("string")
.ignoreUtf8Errors("string")
.multiLine("string")
.nullIfs("string")
.replaceInvalidCharacters("string")
.skipByteOrderMark("string")
.stripNullValues("string")
.stripOuterArray("string")
.timeFormat("string")
.timestampFormat("string")
.trimSpace("string")
.build())
.orc(StageExternalS3FileFormatOrcArgs.builder()
.nullIfs("string")
.replaceInvalidCharacters("string")
.trimSpace("string")
.build())
.parquet(StageExternalS3FileFormatParquetArgs.builder()
.binaryAsText("string")
.compression("string")
.nullIfs("string")
.replaceInvalidCharacters("string")
.trimSpace("string")
.useLogicalType("string")
.useVectorizedScanner("string")
.build())
.xml(StageExternalS3FileFormatXmlArgs.builder()
.compression("string")
.disableAutoConvert("string")
.ignoreUtf8Errors("string")
.preserveSpace("string")
.replaceInvalidCharacters("string")
.skipByteOrderMark("string")
.stripOuterElement("string")
.build())
.build())
.name("string")
.storageIntegration("string")
.usePrivatelinkEndpoint("string")
.build());
stage_external_s3_resource = snowflake.StageExternalS3("stageExternalS3Resource",
database="string",
schema="string",
url="string",
aws_access_point_arn="string",
comment="string",
credentials={
"aws_key_id": "string",
"aws_role": "string",
"aws_secret_key": "string",
"aws_token": "string",
},
directory={
"enable": False,
"auto_refresh": "string",
"refresh_on_create": "string",
},
encryption={
"aws_cse": {
"master_key": "string",
},
"aws_sse_kms": {
"kms_key_id": "string",
},
"aws_sse_s3": {},
"none": {},
},
file_format={
"avro": {
"compression": "string",
"null_ifs": ["string"],
"replace_invalid_characters": "string",
"trim_space": "string",
},
"csv": {
"binary_format": "string",
"compression": "string",
"date_format": "string",
"empty_field_as_null": "string",
"encoding": "string",
"error_on_column_count_mismatch": "string",
"escape": "string",
"escape_unenclosed_field": "string",
"field_delimiter": "string",
"field_optionally_enclosed_by": "string",
"file_extension": "string",
"multi_line": "string",
"null_ifs": ["string"],
"parse_header": "string",
"record_delimiter": "string",
"replace_invalid_characters": "string",
"skip_blank_lines": "string",
"skip_byte_order_mark": "string",
"skip_header": 0,
"time_format": "string",
"timestamp_format": "string",
"trim_space": "string",
},
"format_name": "string",
"json": {
"allow_duplicate": "string",
"binary_format": "string",
"compression": "string",
"date_format": "string",
"enable_octal": "string",
"file_extension": "string",
"ignore_utf8_errors": "string",
"multi_line": "string",
"null_ifs": ["string"],
"replace_invalid_characters": "string",
"skip_byte_order_mark": "string",
"strip_null_values": "string",
"strip_outer_array": "string",
"time_format": "string",
"timestamp_format": "string",
"trim_space": "string",
},
"orc": {
"null_ifs": ["string"],
"replace_invalid_characters": "string",
"trim_space": "string",
},
"parquet": {
"binary_as_text": "string",
"compression": "string",
"null_ifs": ["string"],
"replace_invalid_characters": "string",
"trim_space": "string",
"use_logical_type": "string",
"use_vectorized_scanner": "string",
},
"xml": {
"compression": "string",
"disable_auto_convert": "string",
"ignore_utf8_errors": "string",
"preserve_space": "string",
"replace_invalid_characters": "string",
"skip_byte_order_mark": "string",
"strip_outer_element": "string",
},
},
name="string",
storage_integration="string",
use_privatelink_endpoint="string")
const stageExternalS3Resource = new snowflake.StageExternalS3("stageExternalS3Resource", {
database: "string",
schema: "string",
url: "string",
awsAccessPointArn: "string",
comment: "string",
credentials: {
awsKeyId: "string",
awsRole: "string",
awsSecretKey: "string",
awsToken: "string",
},
directory: {
enable: false,
autoRefresh: "string",
refreshOnCreate: "string",
},
encryption: {
awsCse: {
masterKey: "string",
},
awsSseKms: {
kmsKeyId: "string",
},
awsSseS3: {},
none: {},
},
fileFormat: {
avro: {
compression: "string",
nullIfs: ["string"],
replaceInvalidCharacters: "string",
trimSpace: "string",
},
csv: {
binaryFormat: "string",
compression: "string",
dateFormat: "string",
emptyFieldAsNull: "string",
encoding: "string",
errorOnColumnCountMismatch: "string",
escape: "string",
escapeUnenclosedField: "string",
fieldDelimiter: "string",
fieldOptionallyEnclosedBy: "string",
fileExtension: "string",
multiLine: "string",
nullIfs: ["string"],
parseHeader: "string",
recordDelimiter: "string",
replaceInvalidCharacters: "string",
skipBlankLines: "string",
skipByteOrderMark: "string",
skipHeader: 0,
timeFormat: "string",
timestampFormat: "string",
trimSpace: "string",
},
formatName: "string",
json: {
allowDuplicate: "string",
binaryFormat: "string",
compression: "string",
dateFormat: "string",
enableOctal: "string",
fileExtension: "string",
ignoreUtf8Errors: "string",
multiLine: "string",
nullIfs: ["string"],
replaceInvalidCharacters: "string",
skipByteOrderMark: "string",
stripNullValues: "string",
stripOuterArray: "string",
timeFormat: "string",
timestampFormat: "string",
trimSpace: "string",
},
orc: {
nullIfs: ["string"],
replaceInvalidCharacters: "string",
trimSpace: "string",
},
parquet: {
binaryAsText: "string",
compression: "string",
nullIfs: ["string"],
replaceInvalidCharacters: "string",
trimSpace: "string",
useLogicalType: "string",
useVectorizedScanner: "string",
},
xml: {
compression: "string",
disableAutoConvert: "string",
ignoreUtf8Errors: "string",
preserveSpace: "string",
replaceInvalidCharacters: "string",
skipByteOrderMark: "string",
stripOuterElement: "string",
},
},
name: "string",
storageIntegration: "string",
usePrivatelinkEndpoint: "string",
});
type: snowflake:StageExternalS3
properties:
awsAccessPointArn: string
comment: string
credentials:
awsKeyId: string
awsRole: string
awsSecretKey: string
awsToken: string
database: string
directory:
autoRefresh: string
enable: false
refreshOnCreate: string
encryption:
awsCse:
masterKey: string
awsSseKms:
kmsKeyId: string
awsSseS3: {}
none: {}
fileFormat:
avro:
compression: string
nullIfs:
- string
replaceInvalidCharacters: string
trimSpace: string
csv:
binaryFormat: string
compression: string
dateFormat: string
emptyFieldAsNull: string
encoding: string
errorOnColumnCountMismatch: string
escape: string
escapeUnenclosedField: string
fieldDelimiter: string
fieldOptionallyEnclosedBy: string
fileExtension: string
multiLine: string
nullIfs:
- string
parseHeader: string
recordDelimiter: string
replaceInvalidCharacters: string
skipBlankLines: string
skipByteOrderMark: string
skipHeader: 0
timeFormat: string
timestampFormat: string
trimSpace: string
formatName: string
json:
allowDuplicate: string
binaryFormat: string
compression: string
dateFormat: string
enableOctal: string
fileExtension: string
ignoreUtf8Errors: string
multiLine: string
nullIfs:
- string
replaceInvalidCharacters: string
skipByteOrderMark: string
stripNullValues: string
stripOuterArray: string
timeFormat: string
timestampFormat: string
trimSpace: string
orc:
nullIfs:
- string
replaceInvalidCharacters: string
trimSpace: string
parquet:
binaryAsText: string
compression: string
nullIfs:
- string
replaceInvalidCharacters: string
trimSpace: string
useLogicalType: string
useVectorizedScanner: string
xml:
compression: string
disableAutoConvert: string
ignoreUtf8Errors: string
preserveSpace: string
replaceInvalidCharacters: string
skipByteOrderMark: string
stripOuterElement: string
name: string
schema: string
storageIntegration: string
url: string
usePrivatelinkEndpoint: string
StageExternalS3 Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The StageExternalS3 resource accepts the following input properties:
- Database string
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Url string
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- Aws
Access stringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- Comment string
- Specifies a comment for the stage.
- Credentials
Stage
External S3Credentials - Specifies the AWS credentials for the external stage.
- Directory
Stage
External S3Directory - Directory tables store a catalog of staged files in cloud storage.
- Encryption
Stage
External S3Encryption - Specifies the encryption settings for the S3 external stage.
- File
Format StageExternal S3File Format - Specifies the file format for the stage.
- Name string
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Storage
Integration string - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Use
Privatelink stringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- Database string
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Url string
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- Aws
Access stringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- Comment string
- Specifies a comment for the stage.
- Credentials
Stage
External S3Credentials Args - Specifies the AWS credentials for the external stage.
- Directory
Stage
External S3Directory Args - Directory tables store a catalog of staged files in cloud storage.
- Encryption
Stage
External S3Encryption Args - Specifies the encryption settings for the S3 external stage.
- File
Format StageExternal S3File Format Args - Specifies the file format for the stage.
- Name string
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Storage
Integration string - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Use
Privatelink stringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- database String
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url String
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- aws
Access StringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- comment String
- Specifies a comment for the stage.
- credentials
Stage
External S3Credentials - Specifies the AWS credentials for the external stage.
- directory
Stage
External S3Directory - Directory tables store a catalog of staged files in cloud storage.
- encryption
Stage
External S3Encryption - Specifies the encryption settings for the S3 external stage.
- file
Format StageExternal S3File Format - Specifies the file format for the stage.
- name String
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - storage
Integration String - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - use
Privatelink StringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- database string
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema string
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url string
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- aws
Access stringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- comment string
- Specifies a comment for the stage.
- credentials
Stage
External S3Credentials - Specifies the AWS credentials for the external stage.
- directory
Stage
External S3Directory - Directory tables store a catalog of staged files in cloud storage.
- encryption
Stage
External S3Encryption - Specifies the encryption settings for the S3 external stage.
- file
Format StageExternal S3File Format - Specifies the file format for the stage.
- name string
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - storage
Integration string - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - use
Privatelink stringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- database str
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema str
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url str
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- aws_
access_ strpoint_ arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- comment str
- Specifies a comment for the stage.
- credentials
Stage
External S3Credentials Args - Specifies the AWS credentials for the external stage.
- directory
Stage
External S3Directory Args - Directory tables store a catalog of staged files in cloud storage.
- encryption
Stage
External S3Encryption Args - Specifies the encryption settings for the S3 external stage.
- file_
format StageExternal S3File Format Args - Specifies the file format for the stage.
- name str
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - storage_
integration str - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - use_
privatelink_ strendpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- database String
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url String
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- aws
Access StringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- comment String
- Specifies a comment for the stage.
- credentials Property Map
- Specifies the AWS credentials for the external stage.
- directory Property Map
- Directory tables store a catalog of staged files in cloud storage.
- encryption Property Map
- Specifies the encryption settings for the S3 external stage.
- file
Format Property Map - Specifies the file format for the stage.
- name String
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - storage
Integration String - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - use
Privatelink StringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
Outputs
All input properties are implicitly available as output properties. Additionally, the StageExternalS3 resource produces the following output properties:
- Cloud string
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- Describe
Outputs List<StageExternal S3Describe Output> - Outputs the result of
DESCRIBE STAGEfor the given stage. - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Show
Outputs List<StageExternal S3Show Output> - Outputs the result of
SHOW STAGESfor the given stage. - Stage
Type string - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- Cloud string
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- Describe
Outputs []StageExternal S3Describe Output - Outputs the result of
DESCRIBE STAGEfor the given stage. - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Show
Outputs []StageExternal S3Show Output - Outputs the result of
SHOW STAGESfor the given stage. - Stage
Type string - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- cloud String
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- describe
Outputs List<StageExternal S3Describe Output> - Outputs the result of
DESCRIBE STAGEfor the given stage. - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- show
Outputs List<StageExternal S3Show Output> - Outputs the result of
SHOW STAGESfor the given stage. - stage
Type String - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- cloud string
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- describe
Outputs StageExternal S3Describe Output[] - Outputs the result of
DESCRIBE STAGEfor the given stage. - fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- show
Outputs StageExternal S3Show Output[] - Outputs the result of
SHOW STAGESfor the given stage. - stage
Type string - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- cloud str
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- describe_
outputs Sequence[StageExternal S3Describe Output] - Outputs the result of
DESCRIBE STAGEfor the given stage. - fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- show_
outputs Sequence[StageExternal S3Show Output] - Outputs the result of
SHOW STAGESfor the given stage. - stage_
type str - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- cloud String
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE STAGEfor the given stage. - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- show
Outputs List<Property Map> - Outputs the result of
SHOW STAGESfor the given stage. - stage
Type String - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
Look up Existing StageExternalS3 Resource
Get an existing StageExternalS3 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: StageExternalS3State, opts?: CustomResourceOptions): StageExternalS3@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aws_access_point_arn: Optional[str] = None,
cloud: Optional[str] = None,
comment: Optional[str] = None,
credentials: Optional[StageExternalS3CredentialsArgs] = None,
database: Optional[str] = None,
describe_outputs: Optional[Sequence[StageExternalS3DescribeOutputArgs]] = None,
directory: Optional[StageExternalS3DirectoryArgs] = None,
encryption: Optional[StageExternalS3EncryptionArgs] = None,
file_format: Optional[StageExternalS3FileFormatArgs] = None,
fully_qualified_name: Optional[str] = None,
name: Optional[str] = None,
schema: Optional[str] = None,
show_outputs: Optional[Sequence[StageExternalS3ShowOutputArgs]] = None,
stage_type: Optional[str] = None,
storage_integration: Optional[str] = None,
url: Optional[str] = None,
use_privatelink_endpoint: Optional[str] = None) -> StageExternalS3func GetStageExternalS3(ctx *Context, name string, id IDInput, state *StageExternalS3State, opts ...ResourceOption) (*StageExternalS3, error)public static StageExternalS3 Get(string name, Input<string> id, StageExternalS3State? state, CustomResourceOptions? opts = null)public static StageExternalS3 get(String name, Output<String> id, StageExternalS3State state, CustomResourceOptions options)resources: _: type: snowflake:StageExternalS3 get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Aws
Access stringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- Cloud string
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- Comment string
- Specifies a comment for the stage.
- Credentials
Stage
External S3Credentials - Specifies the AWS credentials for the external stage.
- Database string
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Describe
Outputs List<StageExternal S3Describe Output> - Outputs the result of
DESCRIBE STAGEfor the given stage. - Directory
Stage
External S3Directory - Directory tables store a catalog of staged files in cloud storage.
- Encryption
Stage
External S3Encryption - Specifies the encryption settings for the S3 external stage.
- File
Format StageExternal S3File Format - Specifies the file format for the stage.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Show
Outputs List<StageExternal S3Show Output> - Outputs the result of
SHOW STAGESfor the given stage. - Stage
Type string - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- Storage
Integration string - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Url string
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- Use
Privatelink stringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- Aws
Access stringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- Cloud string
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- Comment string
- Specifies a comment for the stage.
- Credentials
Stage
External S3Credentials Args - Specifies the AWS credentials for the external stage.
- Database string
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Describe
Outputs []StageExternal S3Describe Output Args - Outputs the result of
DESCRIBE STAGEfor the given stage. - Directory
Stage
External S3Directory Args - Directory tables store a catalog of staged files in cloud storage.
- Encryption
Stage
External S3Encryption Args - Specifies the encryption settings for the S3 external stage.
- File
Format StageExternal S3File Format Args - Specifies the file format for the stage.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Schema string
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Show
Outputs []StageExternal S3Show Output Args - Outputs the result of
SHOW STAGESfor the given stage. - Stage
Type string - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- Storage
Integration string - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Url string
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- Use
Privatelink stringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- aws
Access StringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- cloud String
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- comment String
- Specifies a comment for the stage.
- credentials
Stage
External S3Credentials - Specifies the AWS credentials for the external stage.
- database String
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - describe
Outputs List<StageExternal S3Describe Output> - Outputs the result of
DESCRIBE STAGEfor the given stage. - directory
Stage
External S3Directory - Directory tables store a catalog of staged files in cloud storage.
- encryption
Stage
External S3Encryption - Specifies the encryption settings for the S3 external stage.
- file
Format StageExternal S3File Format - Specifies the file format for the stage.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show
Outputs List<StageExternal S3Show Output> - Outputs the result of
SHOW STAGESfor the given stage. - stage
Type String - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- storage
Integration String - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url String
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- use
Privatelink StringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- aws
Access stringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- cloud string
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- comment string
- Specifies a comment for the stage.
- credentials
Stage
External S3Credentials - Specifies the AWS credentials for the external stage.
- database string
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - describe
Outputs StageExternal S3Describe Output[] - Outputs the result of
DESCRIBE STAGEfor the given stage. - directory
Stage
External S3Directory - Directory tables store a catalog of staged files in cloud storage.
- encryption
Stage
External S3Encryption - Specifies the encryption settings for the S3 external stage.
- file
Format StageExternal S3File Format - Specifies the file format for the stage.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- name string
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema string
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show
Outputs StageExternal S3Show Output[] - Outputs the result of
SHOW STAGESfor the given stage. - stage
Type string - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- storage
Integration string - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url string
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- use
Privatelink stringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- aws_
access_ strpoint_ arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- cloud str
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- comment str
- Specifies a comment for the stage.
- credentials
Stage
External S3Credentials Args - Specifies the AWS credentials for the external stage.
- database str
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - describe_
outputs Sequence[StageExternal S3Describe Output Args] - Outputs the result of
DESCRIBE STAGEfor the given stage. - directory
Stage
External S3Directory Args - Directory tables store a catalog of staged files in cloud storage.
- encryption
Stage
External S3Encryption Args - Specifies the encryption settings for the S3 external stage.
- file_
format StageExternal S3File Format Args - Specifies the file format for the stage.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- name str
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema str
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show_
outputs Sequence[StageExternal S3Show Output Args] - Outputs the result of
SHOW STAGESfor the given stage. - stage_
type str - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- storage_
integration str - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url str
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- use_
privatelink_ strendpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
- aws
Access StringPoint Arn - Specifies the ARN for an AWS S3 Access Point to use for data transfer.
- cloud String
- Specifies a cloud provider for the stage. This field is used for checking external changes and recreating the resources if needed.
- comment String
- Specifies a comment for the stage.
- credentials Property Map
- Specifies the AWS credentials for the external stage.
- database String
- The database in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE STAGEfor the given stage. - directory Property Map
- Directory tables store a catalog of staged files in cloud storage.
- encryption Property Map
- Specifies the encryption settings for the S3 external stage.
- file
Format Property Map - Specifies the file format for the stage.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the identifier for the stage; must be unique for the database and schema in which the stage is created. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - schema String
- The schema in which to create the stage. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - show
Outputs List<Property Map> - Outputs the result of
SHOW STAGESfor the given stage. - stage
Type String - Specifies a type for the stage. This field is used for checking external changes and recreating the resources if needed.
- storage
Integration String - Specifies the name of the storage integration used to delegate authentication responsibility to a Snowflake identity. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - url String
- Specifies the URL for the S3 bucket (e.g., 's3://bucket-name/path/').
- use
Privatelink StringEndpoint - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to use a private link endpoint for S3 storage.
Supporting Types
StageExternalS3Credentials, StageExternalS3CredentialsArgs
- Aws
Key stringId - Specifies the AWS access key ID.
- Aws
Role string - Specifies the AWS IAM role ARN to use for accessing the bucket.
- Aws
Secret stringKey - Specifies the AWS secret access key.
- Aws
Token string - Specifies the AWS session token for temporary credentials.
- Aws
Key stringId - Specifies the AWS access key ID.
- Aws
Role string - Specifies the AWS IAM role ARN to use for accessing the bucket.
- Aws
Secret stringKey - Specifies the AWS secret access key.
- Aws
Token string - Specifies the AWS session token for temporary credentials.
- aws
Key StringId - Specifies the AWS access key ID.
- aws
Role String - Specifies the AWS IAM role ARN to use for accessing the bucket.
- aws
Secret StringKey - Specifies the AWS secret access key.
- aws
Token String - Specifies the AWS session token for temporary credentials.
- aws
Key stringId - Specifies the AWS access key ID.
- aws
Role string - Specifies the AWS IAM role ARN to use for accessing the bucket.
- aws
Secret stringKey - Specifies the AWS secret access key.
- aws
Token string - Specifies the AWS session token for temporary credentials.
- aws_
key_ strid - Specifies the AWS access key ID.
- aws_
role str - Specifies the AWS IAM role ARN to use for accessing the bucket.
- aws_
secret_ strkey - Specifies the AWS secret access key.
- aws_
token str - Specifies the AWS session token for temporary credentials.
- aws
Key StringId - Specifies the AWS access key ID.
- aws
Role String - Specifies the AWS IAM role ARN to use for accessing the bucket.
- aws
Secret StringKey - Specifies the AWS secret access key.
- aws
Token String - Specifies the AWS session token for temporary credentials.
StageExternalS3DescribeOutput, StageExternalS3DescribeOutputArgs
StageExternalS3DescribeOutputDirectoryTable, StageExternalS3DescribeOutputDirectoryTableArgs
- Auto
Refresh bool - Enable bool
- Auto
Refresh bool - Enable bool
- auto
Refresh Boolean - enable Boolean
- auto
Refresh boolean - enable boolean
- auto_
refresh bool - enable bool
- auto
Refresh Boolean - enable Boolean
StageExternalS3DescribeOutputFileFormat, StageExternalS3DescribeOutputFileFormatArgs
- Avros
List<Stage
External S3Describe Output File Format Avro> - Csvs
List<Stage
External S3Describe Output File Format Csv> - Format
Name string - Jsons
List<Stage
External S3Describe Output File Format Json> - Orcs
List<Stage
External S3Describe Output File Format Orc> - Parquets
List<Stage
External S3Describe Output File Format Parquet> - Xmls
List<Stage
External S3Describe Output File Format Xml>
- Avros
[]Stage
External S3Describe Output File Format Avro - Csvs
[]Stage
External S3Describe Output File Format Csv - Format
Name string - Jsons
[]Stage
External S3Describe Output File Format Json - Orcs
[]Stage
External S3Describe Output File Format Orc - Parquets
[]Stage
External S3Describe Output File Format Parquet - Xmls
[]Stage
External S3Describe Output File Format Xml
- avros
List<Stage
External S3Describe Output File Format Avro> - csvs
List<Stage
External S3Describe Output File Format Csv> - format
Name String - jsons
List<Stage
External S3Describe Output File Format Json> - orcs
List<Stage
External S3Describe Output File Format Orc> - parquets
List<Stage
External S3Describe Output File Format Parquet> - xmls
List<Stage
External S3Describe Output File Format Xml>
- avros
Stage
External S3Describe Output File Format Avro[] - csvs
Stage
External S3Describe Output File Format Csv[] - format
Name string - jsons
Stage
External S3Describe Output File Format Json[] - orcs
Stage
External S3Describe Output File Format Orc[] - parquets
Stage
External S3Describe Output File Format Parquet[] - xmls
Stage
External S3Describe Output File Format Xml[]
- avros
Sequence[Stage
External S3Describe Output File Format Avro] - csvs
Sequence[Stage
External S3Describe Output File Format Csv] - format_
name str - jsons
Sequence[Stage
External S3Describe Output File Format Json] - orcs
Sequence[Stage
External S3Describe Output File Format Orc] - parquets
Sequence[Stage
External S3Describe Output File Format Parquet] - xmls
Sequence[Stage
External S3Describe Output File Format Xml]
StageExternalS3DescribeOutputFileFormatAvro, StageExternalS3DescribeOutputFileFormatAvroArgs
- Compression string
- Null
Ifs List<string> - Replace
Invalid boolCharacters - Trim
Space bool - Type string
- Compression string
- Null
Ifs []string - Replace
Invalid boolCharacters - Trim
Space bool - Type string
- compression String
- null
Ifs List<String> - replace
Invalid BooleanCharacters - trim
Space Boolean - type String
- compression string
- null
Ifs string[] - replace
Invalid booleanCharacters - trim
Space boolean - type string
- compression str
- null_
ifs Sequence[str] - replace_
invalid_ boolcharacters - trim_
space bool - type str
- compression String
- null
Ifs List<String> - replace
Invalid BooleanCharacters - trim
Space Boolean - type String
StageExternalS3DescribeOutputFileFormatCsv, StageExternalS3DescribeOutputFileFormatCsvArgs
- Binary
Format string - Compression string
- Date
Format string - Empty
Field boolAs Null - Encoding string
- Error
On boolColumn Count Mismatch - Escape string
- Escape
Unenclosed stringField - Field
Delimiter string - Field
Optionally stringEnclosed By - File
Extension string - Multi
Line bool - Null
Ifs List<string> - Parse
Header bool - Record
Delimiter string - Replace
Invalid boolCharacters - Skip
Blank boolLines - Skip
Byte boolOrder Mark - Skip
Header int - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- Validate
Utf8 bool
- Binary
Format string - Compression string
- Date
Format string - Empty
Field boolAs Null - Encoding string
- Error
On boolColumn Count Mismatch - Escape string
- Escape
Unenclosed stringField - Field
Delimiter string - Field
Optionally stringEnclosed By - File
Extension string - Multi
Line bool - Null
Ifs []string - Parse
Header bool - Record
Delimiter string - Replace
Invalid boolCharacters - Skip
Blank boolLines - Skip
Byte boolOrder Mark - Skip
Header int - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- Validate
Utf8 bool
- binary
Format String - compression String
- date
Format String - empty
Field BooleanAs Null - encoding String
- error
On BooleanColumn Count Mismatch - escape String
- escape
Unenclosed StringField - field
Delimiter String - field
Optionally StringEnclosed By - file
Extension String - multi
Line Boolean - null
Ifs List<String> - parse
Header Boolean - record
Delimiter String - replace
Invalid BooleanCharacters - skip
Blank BooleanLines - skip
Byte BooleanOrder Mark - skip
Header Integer - time
Format String - timestamp
Format String - trim
Space Boolean - type String
- validate
Utf8 Boolean
- binary
Format string - compression string
- date
Format string - empty
Field booleanAs Null - encoding string
- error
On booleanColumn Count Mismatch - escape string
- escape
Unenclosed stringField - field
Delimiter string - field
Optionally stringEnclosed By - file
Extension string - multi
Line boolean - null
Ifs string[] - parse
Header boolean - record
Delimiter string - replace
Invalid booleanCharacters - skip
Blank booleanLines - skip
Byte booleanOrder Mark - skip
Header number - time
Format string - timestamp
Format string - trim
Space boolean - type string
- validate
Utf8 boolean
- binary_
format str - compression str
- date_
format str - empty_
field_ boolas_ null - encoding str
- error_
on_ boolcolumn_ count_ mismatch - escape str
- escape_
unenclosed_ strfield - field_
delimiter str - field_
optionally_ strenclosed_ by - file_
extension str - multi_
line bool - null_
ifs Sequence[str] - parse_
header bool - record_
delimiter str - replace_
invalid_ boolcharacters - skip_
blank_ boollines - skip_
byte_ boolorder_ mark - skip_
header int - time_
format str - timestamp_
format str - trim_
space bool - type str
- validate_
utf8 bool
- binary
Format String - compression String
- date
Format String - empty
Field BooleanAs Null - encoding String
- error
On BooleanColumn Count Mismatch - escape String
- escape
Unenclosed StringField - field
Delimiter String - field
Optionally StringEnclosed By - file
Extension String - multi
Line Boolean - null
Ifs List<String> - parse
Header Boolean - record
Delimiter String - replace
Invalid BooleanCharacters - skip
Blank BooleanLines - skip
Byte BooleanOrder Mark - skip
Header Number - time
Format String - timestamp
Format String - trim
Space Boolean - type String
- validate
Utf8 Boolean
StageExternalS3DescribeOutputFileFormatJson, StageExternalS3DescribeOutputFileFormatJsonArgs
- Allow
Duplicate bool - Binary
Format string - Compression string
- Date
Format string - Enable
Octal bool - File
Extension string - Ignore
Utf8Errors bool - Multi
Line bool - Null
Ifs List<string> - Replace
Invalid boolCharacters - Skip
Byte boolOrder Mark - Strip
Null boolValues - Strip
Outer boolArray - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- Allow
Duplicate bool - Binary
Format string - Compression string
- Date
Format string - Enable
Octal bool - File
Extension string - Ignore
Utf8Errors bool - Multi
Line bool - Null
Ifs []string - Replace
Invalid boolCharacters - Skip
Byte boolOrder Mark - Strip
Null boolValues - Strip
Outer boolArray - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- allow
Duplicate Boolean - binary
Format String - compression String
- date
Format String - enable
Octal Boolean - file
Extension String - ignore
Utf8Errors Boolean - multi
Line Boolean - null
Ifs List<String> - replace
Invalid BooleanCharacters - skip
Byte BooleanOrder Mark - strip
Null BooleanValues - strip
Outer BooleanArray - time
Format String - timestamp
Format String - trim
Space Boolean - type String
- allow
Duplicate boolean - binary
Format string - compression string
- date
Format string - enable
Octal boolean - file
Extension string - ignore
Utf8Errors boolean - multi
Line boolean - null
Ifs string[] - replace
Invalid booleanCharacters - skip
Byte booleanOrder Mark - strip
Null booleanValues - strip
Outer booleanArray - time
Format string - timestamp
Format string - trim
Space boolean - type string
- allow_
duplicate bool - binary_
format str - compression str
- date_
format str - enable_
octal bool - file_
extension str - ignore_
utf8_ boolerrors - multi_
line bool - null_
ifs Sequence[str] - replace_
invalid_ boolcharacters - skip_
byte_ boolorder_ mark - strip_
null_ boolvalues - strip_
outer_ boolarray - time_
format str - timestamp_
format str - trim_
space bool - type str
- allow
Duplicate Boolean - binary
Format String - compression String
- date
Format String - enable
Octal Boolean - file
Extension String - ignore
Utf8Errors Boolean - multi
Line Boolean - null
Ifs List<String> - replace
Invalid BooleanCharacters - skip
Byte BooleanOrder Mark - strip
Null BooleanValues - strip
Outer BooleanArray - time
Format String - timestamp
Format String - trim
Space Boolean - type String
StageExternalS3DescribeOutputFileFormatOrc, StageExternalS3DescribeOutputFileFormatOrcArgs
- Null
Ifs List<string> - Replace
Invalid boolCharacters - Trim
Space bool - Type string
- Null
Ifs []string - Replace
Invalid boolCharacters - Trim
Space bool - Type string
- null
Ifs List<String> - replace
Invalid BooleanCharacters - trim
Space Boolean - type String
- null
Ifs string[] - replace
Invalid booleanCharacters - trim
Space boolean - type string
- null_
ifs Sequence[str] - replace_
invalid_ boolcharacters - trim_
space bool - type str
- null
Ifs List<String> - replace
Invalid BooleanCharacters - trim
Space Boolean - type String
StageExternalS3DescribeOutputFileFormatParquet, StageExternalS3DescribeOutputFileFormatParquetArgs
- Binary
As boolText - Compression string
- Null
Ifs List<string> - Replace
Invalid boolCharacters - Trim
Space bool - Type string
- Use
Logical boolType - Use
Vectorized boolScanner
- Binary
As boolText - Compression string
- Null
Ifs []string - Replace
Invalid boolCharacters - Trim
Space bool - Type string
- Use
Logical boolType - Use
Vectorized boolScanner
- binary
As BooleanText - compression String
- null
Ifs List<String> - replace
Invalid BooleanCharacters - trim
Space Boolean - type String
- use
Logical BooleanType - use
Vectorized BooleanScanner
- binary
As booleanText - compression string
- null
Ifs string[] - replace
Invalid booleanCharacters - trim
Space boolean - type string
- use
Logical booleanType - use
Vectorized booleanScanner
- binary_
as_ booltext - compression str
- null_
ifs Sequence[str] - replace_
invalid_ boolcharacters - trim_
space bool - type str
- use_
logical_ booltype - use_
vectorized_ boolscanner
- binary
As BooleanText - compression String
- null
Ifs List<String> - replace
Invalid BooleanCharacters - trim
Space Boolean - type String
- use
Logical BooleanType - use
Vectorized BooleanScanner
StageExternalS3DescribeOutputFileFormatXml, StageExternalS3DescribeOutputFileFormatXmlArgs
- Compression string
- Disable
Auto boolConvert - Ignore
Utf8Errors bool - Preserve
Space bool - Replace
Invalid boolCharacters - Skip
Byte boolOrder Mark - Strip
Outer boolElement - Type string
- Compression string
- Disable
Auto boolConvert - Ignore
Utf8Errors bool - Preserve
Space bool - Replace
Invalid boolCharacters - Skip
Byte boolOrder Mark - Strip
Outer boolElement - Type string
- compression String
- disable
Auto BooleanConvert - ignore
Utf8Errors Boolean - preserve
Space Boolean - replace
Invalid BooleanCharacters - skip
Byte BooleanOrder Mark - strip
Outer BooleanElement - type String
- compression string
- disable
Auto booleanConvert - ignore
Utf8Errors boolean - preserve
Space boolean - replace
Invalid booleanCharacters - skip
Byte booleanOrder Mark - strip
Outer booleanElement - type string
- compression str
- disable_
auto_ boolconvert - ignore_
utf8_ boolerrors - preserve_
space bool - replace_
invalid_ boolcharacters - skip_
byte_ boolorder_ mark - strip_
outer_ boolelement - type str
- compression String
- disable
Auto BooleanConvert - ignore
Utf8Errors Boolean - preserve
Space Boolean - replace
Invalid BooleanCharacters - skip
Byte BooleanOrder Mark - strip
Outer BooleanElement - type String
StageExternalS3DescribeOutputLocation, StageExternalS3DescribeOutputLocationArgs
- Aws
Access stringPoint Arn - Urls List<string>
- Aws
Access stringPoint Arn - Urls []string
- aws
Access StringPoint Arn - urls List<String>
- aws
Access stringPoint Arn - urls string[]
- aws_
access_ strpoint_ arn - urls Sequence[str]
- aws
Access StringPoint Arn - urls List<String>
StageExternalS3DescribeOutputPrivatelink, StageExternalS3DescribeOutputPrivatelinkArgs
- use
Privatelink BooleanEndpoint
- use
Privatelink booleanEndpoint
- use
Privatelink BooleanEndpoint
StageExternalS3Directory, StageExternalS3DirectoryArgs
- Enable bool
- Specifies whether to enable a directory table on the external stage.
- Auto
Refresh string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata. - Refresh
On stringCreate - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created.This field is used only when creating the object. Changes on this field are ignored after creation.
- Enable bool
- Specifies whether to enable a directory table on the external stage.
- Auto
Refresh string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata. - Refresh
On stringCreate - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created.This field is used only when creating the object. Changes on this field are ignored after creation.
- enable Boolean
- Specifies whether to enable a directory table on the external stage.
- auto
Refresh String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata. - refresh
On StringCreate - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created.This field is used only when creating the object. Changes on this field are ignored after creation.
- enable boolean
- Specifies whether to enable a directory table on the external stage.
- auto
Refresh string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata. - refresh
On stringCreate - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created.This field is used only when creating the object. Changes on this field are ignored after creation.
- enable bool
- Specifies whether to enable a directory table on the external stage.
- auto_
refresh str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata. - refresh_
on_ strcreate - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created.This field is used only when creating the object. Changes on this field are ignored after creation.
- enable Boolean
- Specifies whether to enable a directory table on the external stage.
- auto
Refresh String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata. - refresh
On StringCreate - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created.This field is used only when creating the object. Changes on this field are ignored after creation.
StageExternalS3Encryption, StageExternalS3EncryptionArgs
- Aws
Cse StageExternal S3Encryption Aws Cse - AWS client-side encryption using a master key.
- Aws
Sse StageKms External S3Encryption Aws Sse Kms - AWS server-side encryption using KMS-managed keys.
- Aws
Sse StageS3 External S3Encryption Aws Sse S3 - AWS server-side encryption using S3-managed keys.
- None
Stage
External S3Encryption None - No encryption.
- Aws
Cse StageExternal S3Encryption Aws Cse - AWS client-side encryption using a master key.
- Aws
Sse StageKms External S3Encryption Aws Sse Kms - AWS server-side encryption using KMS-managed keys.
- Aws
Sse StageS3 External S3Encryption Aws Sse S3 - AWS server-side encryption using S3-managed keys.
- None
Stage
External S3Encryption None - No encryption.
- aws
Cse StageExternal S3Encryption Aws Cse - AWS client-side encryption using a master key.
- aws
Sse StageKms External S3Encryption Aws Sse Kms - AWS server-side encryption using KMS-managed keys.
- aws
Sse StageS3 External S3Encryption Aws Sse S3 - AWS server-side encryption using S3-managed keys.
- none
Stage
External S3Encryption None - No encryption.
- aws
Cse StageExternal S3Encryption Aws Cse - AWS client-side encryption using a master key.
- aws
Sse StageKms External S3Encryption Aws Sse Kms - AWS server-side encryption using KMS-managed keys.
- aws
Sse StageS3 External S3Encryption Aws Sse S3 - AWS server-side encryption using S3-managed keys.
- none
Stage
External S3Encryption None - No encryption.
- aws_
cse StageExternal S3Encryption Aws Cse - AWS client-side encryption using a master key.
- aws_
sse_ Stagekms External S3Encryption Aws Sse Kms - AWS server-side encryption using KMS-managed keys.
- aws_
sse_ Stages3 External S3Encryption Aws Sse S3 - AWS server-side encryption using S3-managed keys.
- none
Stage
External S3Encryption None - No encryption.
- aws
Cse Property Map - AWS client-side encryption using a master key.
- aws
Sse Property MapKms - AWS server-side encryption using KMS-managed keys.
- aws
Sse Property MapS3 - AWS server-side encryption using S3-managed keys.
- none Property Map
- No encryption.
StageExternalS3EncryptionAwsCse, StageExternalS3EncryptionAwsCseArgs
- Master
Key string - Specifies the 128-bit or 256-bit client-side master key.
- Master
Key string - Specifies the 128-bit or 256-bit client-side master key.
- master
Key String - Specifies the 128-bit or 256-bit client-side master key.
- master
Key string - Specifies the 128-bit or 256-bit client-side master key.
- master_
key str - Specifies the 128-bit or 256-bit client-side master key.
- master
Key String - Specifies the 128-bit or 256-bit client-side master key.
StageExternalS3EncryptionAwsSseKms, StageExternalS3EncryptionAwsSseKmsArgs
- Kms
Key stringId - Specifies the KMS-managed key ID.
- Kms
Key stringId - Specifies the KMS-managed key ID.
- kms
Key StringId - Specifies the KMS-managed key ID.
- kms
Key stringId - Specifies the KMS-managed key ID.
- kms_
key_ strid - Specifies the KMS-managed key ID.
- kms
Key StringId - Specifies the KMS-managed key ID.
StageExternalS3FileFormat, StageExternalS3FileFormatArgs
- Avro
Stage
External S3File Format Avro - AVRO file format options.
- Csv
Stage
External S3File Format Csv - CSV file format options.
- Format
Name string - Fully qualified name of the file format (e.g., 'database.schema.format_name').
- Json
Stage
External S3File Format Json - JSON file format options.
- Orc
Stage
External S3File Format Orc - ORC file format options.
- Parquet
Stage
External S3File Format Parquet - Parquet file format options.
- Xml
Stage
External S3File Format Xml - XML file format options.
- Avro
Stage
External S3File Format Avro - AVRO file format options.
- Csv
Stage
External S3File Format Csv - CSV file format options.
- Format
Name string - Fully qualified name of the file format (e.g., 'database.schema.format_name').
- Json
Stage
External S3File Format Json - JSON file format options.
- Orc
Stage
External S3File Format Orc - ORC file format options.
- Parquet
Stage
External S3File Format Parquet - Parquet file format options.
- Xml
Stage
External S3File Format Xml - XML file format options.
- avro
Stage
External S3File Format Avro - AVRO file format options.
- csv
Stage
External S3File Format Csv - CSV file format options.
- format
Name String - Fully qualified name of the file format (e.g., 'database.schema.format_name').
- json
Stage
External S3File Format Json - JSON file format options.
- orc
Stage
External S3File Format Orc - ORC file format options.
- parquet
Stage
External S3File Format Parquet - Parquet file format options.
- xml
Stage
External S3File Format Xml - XML file format options.
- avro
Stage
External S3File Format Avro - AVRO file format options.
- csv
Stage
External S3File Format Csv - CSV file format options.
- format
Name string - Fully qualified name of the file format (e.g., 'database.schema.format_name').
- json
Stage
External S3File Format Json - JSON file format options.
- orc
Stage
External S3File Format Orc - ORC file format options.
- parquet
Stage
External S3File Format Parquet - Parquet file format options.
- xml
Stage
External S3File Format Xml - XML file format options.
- avro
Stage
External S3File Format Avro - AVRO file format options.
- csv
Stage
External S3File Format Csv - CSV file format options.
- format_
name str - Fully qualified name of the file format (e.g., 'database.schema.format_name').
- json
Stage
External S3File Format Json - JSON file format options.
- orc
Stage
External S3File Format Orc - ORC file format options.
- parquet
Stage
External S3File Format Parquet - Parquet file format options.
- xml
Stage
External S3File Format Xml - XML file format options.
- avro Property Map
- AVRO file format options.
- csv Property Map
- CSV file format options.
- format
Name String - Fully qualified name of the file format (e.g., 'database.schema.format_name').
- json Property Map
- JSON file format options.
- orc Property Map
- ORC file format options.
- parquet Property Map
- Parquet file format options.
- xml Property Map
- XML file format options.
StageExternalS3FileFormatAvro, StageExternalS3FileFormatAvroArgs
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Null
Ifs List<string> - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Null
Ifs []string - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - null
Ifs string[] - String used to convert to and from SQL NULL.
- replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression str
- Specifies the compression format. Valid values:
AUTO|GZIP|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - null_
ifs Sequence[str] - String used to convert to and from SQL NULL.
- replace_
invalid_ strcharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim_
space str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
StageExternalS3FileFormatCsv, StageExternalS3FileFormatCsvArgs
- Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - Error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - Field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Null
Ifs List<string> - String used to convert to and from SQL NULL.
- Parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - Error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - Field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Null
Ifs []string - String used to convert to and from SQL NULL.
- Parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty
Field StringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - encoding String
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On StringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - escape String
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed StringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter String - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally StringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension String - Specifies the extension for files unloaded to a stage.
- multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- parse
Header String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - record
Delimiter String - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Blank StringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Header Integer - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension string - Specifies the extension for files unloaded to a stage.
- multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null
Ifs string[] - String used to convert to and from SQL NULL.
- parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Header number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary_
format str - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression str
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date_
format str - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty_
field_ stras_ null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - encoding str
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error_
on_ strcolumn_ count_ mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - escape str
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape_
unenclosed_ strfield - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field_
delimiter str - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field_
optionally_ strenclosed_ by - Character used to enclose strings. Use
NONEto specify no enclosure character. - file_
extension str - Specifies the extension for files unloaded to a stage.
- multi_
line str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null_
ifs Sequence[str] - String used to convert to and from SQL NULL.
- parse_
header str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - record_
delimiter str - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace_
invalid_ strcharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip_
blank_ strlines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip_
byte_ strorder_ mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip_
header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time_
format str - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp_
format str - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim_
space str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty
Field StringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - encoding String
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On StringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - escape String
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed StringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter String - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally StringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension String - Specifies the extension for files unloaded to a stage.
- multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- parse
Header String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - record
Delimiter String - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Blank StringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Header Number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
StageExternalS3FileFormatJson, StageExternalS3FileFormatJsonArgs
- Allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Null
Ifs List<string> - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Null
Ifs []string - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- allow
Duplicate String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - enable
Octal String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - file
Extension String - Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Null StringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Outer StringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - file
Extension string - Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null
Ifs string[] - String used to convert to and from SQL NULL.
- replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- allow_
duplicate str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - binary_
format str - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression str
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date_
format str - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - enable_
octal str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - file_
extension str - Specifies the extension for files unloaded to a stage.
- ignore_
utf8_ strerrors - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - multi_
line str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null_
ifs Sequence[str] - String used to convert to and from SQL NULL.
- replace_
invalid_ strcharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip_
byte_ strorder_ mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip_
null_ strvalues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip_
outer_ strarray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - time_
format str - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp_
format str - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim_
space str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- allow
Duplicate String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - enable
Octal String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - file
Extension String - Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow multiple records on a single line. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Null StringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Outer StringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the format. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
StageExternalS3FileFormatOrc, StageExternalS3FileFormatOrcArgs
- Null
Ifs List<string> - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Null
Ifs []string - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- null
Ifs string[] - String used to convert to and from SQL NULL.
- replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- null_
ifs Sequence[str] - String used to convert to and from SQL NULL.
- replace_
invalid_ strcharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim_
space str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
StageExternalS3FileFormatParquet, StageExternalS3FileFormatParquetArgs
- Binary
As stringText - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Compression string
- Specifies the compression format. Valid values:
AUTO|LZO|SNAPPY|NONE. - Null
Ifs List<string> - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Use
Logical stringType - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use Parquet logical types when loading data. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Use
Vectorized stringScanner - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use a vectorized scanner for loading Parquet files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Binary
As stringText - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Compression string
- Specifies the compression format. Valid values:
AUTO|LZO|SNAPPY|NONE. - Null
Ifs []string - String used to convert to and from SQL NULL.
- Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Use
Logical stringType - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use Parquet logical types when loading data. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Use
Vectorized stringScanner - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use a vectorized scanner for loading Parquet files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary
As StringText - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - compression String
- Specifies the compression format. Valid values:
AUTO|LZO|SNAPPY|NONE. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use
Logical StringType - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use Parquet logical types when loading data. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use
Vectorized StringScanner - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use a vectorized scanner for loading Parquet files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary
As stringText - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - compression string
- Specifies the compression format. Valid values:
AUTO|LZO|SNAPPY|NONE. - null
Ifs string[] - String used to convert to and from SQL NULL.
- replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use
Logical stringType - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use Parquet logical types when loading data. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use
Vectorized stringScanner - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use a vectorized scanner for loading Parquet files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary_
as_ strtext - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - compression str
- Specifies the compression format. Valid values:
AUTO|LZO|SNAPPY|NONE. - null_
ifs Sequence[str] - String used to convert to and from SQL NULL.
- replace_
invalid_ strcharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim_
space str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use_
logical_ strtype - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use Parquet logical types when loading data. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use_
vectorized_ strscanner - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use a vectorized scanner for loading Parquet files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- binary
As StringText - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - compression String
- Specifies the compression format. Valid values:
AUTO|LZO|SNAPPY|NONE. - null
Ifs List<String> - String used to convert to and from SQL NULL.
- replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - trim
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use
Logical StringType - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use Parquet logical types when loading data. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - use
Vectorized StringScanner - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use a vectorized scanner for loading Parquet files. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
StageExternalS3FileFormatXml, StageExternalS3FileFormatXmlArgs
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Disable
Auto stringConvert - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Preserve
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Strip
Outer stringElement - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Disable
Auto stringConvert - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Preserve
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - Strip
Outer stringElement - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - disable
Auto StringConvert - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - preserve
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Outer StringElement - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - disable
Auto stringConvert - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - preserve
Space string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - replace
Invalid stringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Outer stringElement - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression str
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - disable_
auto_ strconvert - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - ignore_
utf8_ strerrors - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - preserve_
space str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - replace_
invalid_ strcharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip_
byte_ strorder_ mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip_
outer_ strelement - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - disable
Auto StringConvert - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - preserve
Space String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - replace
Invalid StringCharacters - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value. - strip
Outer StringElement - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
StageExternalS3ShowOutput, StageExternalS3ShowOutputArgs
- Cloud string
- Comment string
- Created
On string - Database
Name string - Directory
Enabled bool - Endpoint string
- Has
Credentials bool - Has
Encryption boolKey - Name string
- Owner string
- Owner
Role stringType - Region string
- Schema
Name string - Storage
Integration string - Type string
- Url string
- Cloud string
- Comment string
- Created
On string - Database
Name string - Directory
Enabled bool - Endpoint string
- Has
Credentials bool - Has
Encryption boolKey - Name string
- Owner string
- Owner
Role stringType - Region string
- Schema
Name string - Storage
Integration string - Type string
- Url string
- cloud String
- comment String
- created
On String - database
Name String - directory
Enabled Boolean - endpoint String
- has
Credentials Boolean - has
Encryption BooleanKey - name String
- owner String
- owner
Role StringType - region String
- schema
Name String - storage
Integration String - type String
- url String
- cloud string
- comment string
- created
On string - database
Name string - directory
Enabled boolean - endpoint string
- has
Credentials boolean - has
Encryption booleanKey - name string
- owner string
- owner
Role stringType - region string
- schema
Name string - storage
Integration string - type string
- url string
- cloud str
- comment str
- created_
on str - database_
name str - directory_
enabled bool - endpoint str
- has_
credentials bool - has_
encryption_ boolkey - name str
- owner str
- owner_
role_ strtype - region str
- schema_
name str - storage_
integration str - type str
- url str
- cloud String
- comment String
- created
On String - database
Name String - directory
Enabled Boolean - endpoint String
- has
Credentials Boolean - has
Encryption BooleanKey - name String
- owner String
- owner
Role StringType - region String
- schema
Name String - storage
Integration String - type String
- url String
Import
$ pulumi import snowflake:index/stageExternalS3:StageExternalS3 example '"<database_name>"."<schema_name>"."<stage_name>"'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflakeTerraform Provider.
