SnowflakeDestinationConfiguration
Configure Snowflake destination
Contents
- AccountUrl
-
URL for accessing your Snowflake account. This URL must include your account identifier
. Note that the protocol (https://) and port number are optional. Type: String
Length Constraints: Minimum length of 24. Maximum length of 2048.
Pattern:
.+?\.snowflakecomputing\.com
Required: Yes
- Database
-
All data in Snowflake is maintained in databases.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- RoleARN
-
The Amazon Resource Name (ARN) of the Snowflake role
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
arn:.*
Required: Yes
- S3Configuration
-
Describes the configuration of a destination in Amazon S3.
Type: S3DestinationConfiguration object
Required: Yes
- Schema
-
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Table
-
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- BufferingHints
-
Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
Type: SnowflakeBufferingHints object
Required: No
- CloudWatchLoggingOptions
-
Describes the Amazon CloudWatch logging options for your Firehose stream.
Type: CloudWatchLoggingOptions object
Required: No
- ContentColumnName
-
The name of the record content column.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- DataLoadingOption
-
Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.
Type: String
Valid Values:
JSON_MAPPING | VARIANT_CONTENT_MAPPING | VARIANT_CONTENT_AND_METADATA_MAPPING
Required: No
- KeyPassphrase
-
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation
. Type: String
Length Constraints: Minimum length of 7. Maximum length of 255.
Required: No
- MetaDataColumnName
-
Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.
For Direct PUT as source
{ "firehoseDeliveryStreamName" : "streamname", "IngestionTime" : "timestamp" }
For Kinesis Data Stream as source
"kinesisStreamName" : "streamname", "kinesisShardId" : "Id", "kinesisPartitionKey" : "key", "kinesisSequenceNumber" : "1234", "subsequenceNumber" : "2334", "IngestionTime" : "timestamp" }
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- PrivateKey
-
The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation
. Type: String
Length Constraints: Minimum length of 256. Maximum length of 4096.
Pattern:
^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
Required: No
- ProcessingConfiguration
-
Describes a data processing configuration.
Type: ProcessingConfiguration object
Required: No
- RetryOptions
-
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
Type: SnowflakeRetryOptions object
Required: No
- S3BackupMode
-
Choose an S3 backup mode
Type: String
Valid Values:
FailedDataOnly | AllData
Required: No
- SecretsManagerConfiguration
-
The configuration that defines how you access secrets for Snowflake.
Type: SecretsManagerConfiguration object
Required: No
- SnowflakeRoleConfiguration
-
Optionally configure a Snowflake role. Otherwise the default user role will be used.
Type: SnowflakeRoleConfiguration object
Required: No
- SnowflakeVpcConfiguration
-
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake
Type: SnowflakeVpcConfiguration object
Required: No
- User
-
User login name for the Snowflake account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: