interface SnowflakeDestinationConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.KinesisFirehose.Mixins.CfnDeliveryStreamPropsMixin.SnowflakeDestinationConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskinesisfirehose/mixins#CfnDeliveryStreamPropsMixin_SnowflakeDestinationConfigurationProperty |
 Java | software.amazon.awscdk.mixins.preview.services.kinesisfirehose.mixins.CfnDeliveryStreamPropsMixin.SnowflakeDestinationConfigurationProperty |
 Python | aws_cdk.mixins_preview.aws_kinesisfirehose.mixins.CfnDeliveryStreamPropsMixin.SnowflakeDestinationConfigurationProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_kinesisfirehose » mixins » CfnDeliveryStreamPropsMixin » SnowflakeDestinationConfigurationProperty |
Configure Snowflake destination.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kinesisfirehose_mixins } from '@aws-cdk/mixins-preview/aws-kinesisfirehose';
const snowflakeDestinationConfigurationProperty: kinesisfirehose_mixins.CfnDeliveryStreamPropsMixin.SnowflakeDestinationConfigurationProperty = {
accountUrl: 'accountUrl',
bufferingHints: {
intervalInSeconds: 123,
sizeInMBs: 123,
},
cloudWatchLoggingOptions: {
enabled: false,
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
},
contentColumnName: 'contentColumnName',
database: 'database',
dataLoadingOption: 'dataLoadingOption',
keyPassphrase: 'keyPassphrase',
metaDataColumnName: 'metaDataColumnName',
privateKey: 'privateKey',
processingConfiguration: {
enabled: false,
processors: [{
parameters: [{
parameterName: 'parameterName',
parameterValue: 'parameterValue',
}],
type: 'type',
}],
},
retryOptions: {
durationInSeconds: 123,
},
roleArn: 'roleArn',
s3BackupMode: 's3BackupMode',
s3Configuration: {
bucketArn: 'bucketArn',
bufferingHints: {
intervalInSeconds: 123,
sizeInMBs: 123,
},
cloudWatchLoggingOptions: {
enabled: false,
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
},
compressionFormat: 'compressionFormat',
encryptionConfiguration: {
kmsEncryptionConfig: {
awskmsKeyArn: 'awskmsKeyArn',
},
noEncryptionConfig: 'noEncryptionConfig',
},
errorOutputPrefix: 'errorOutputPrefix',
prefix: 'prefix',
roleArn: 'roleArn',
},
schema: 'schema',
secretsManagerConfiguration: {
enabled: false,
roleArn: 'roleArn',
secretArn: 'secretArn',
},
snowflakeRoleConfiguration: {
enabled: false,
snowflakeRole: 'snowflakeRole',
},
snowflakeVpcConfiguration: {
privateLinkVpceId: 'privateLinkVpceId',
},
table: 'table',
user: 'user',
};
Properties
| Name | Type | Description |
|---|---|---|
| account | string | URL for accessing your Snowflake account. |
| buffering | IResolvable | Snowflake | Describes the buffering to perform before delivering data to the Snowflake destination. |
| cloud | IResolvable | Cloud | |
| content | string | The name of the record content column. |
| data | string | 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. |
| database? | string | All data in Snowflake is maintained in databases. |
| key | string | Passphrase to decrypt the private key when the key is encrypted. |
| meta | string | Specify a column name in the table, where the metadata information has to be loaded. |
| private | string | The private key used to encrypt your Snowflake client. |
| processing | IResolvable | Processing | |
| retry | IResolvable | Snowflake | The time period where Firehose will retry sending data to the chosen HTTP endpoint. |
| role | string | The Amazon Resource Name (ARN) of the Snowflake role. |
| s3 | string | Choose an S3 backup mode. |
| s3 | IResolvable | S3 | |
| schema? | string | Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views. |
| secrets | IResolvable | Secrets | The configuration that defines how you access secrets for Snowflake. |
| snowflake | IResolvable | Snowflake | Optionally configure a Snowflake role. |
| snowflake | IResolvable | Snowflake | The VPCE ID for Firehose to privately connect with Snowflake. |
| table? | string | All data in Snowflake is stored in database tables, logically structured as collections of columns and rows. |
| user? | string | User login name for the Snowflake account. |
accountUrl?
Type:
string
(optional)
URL for accessing your Snowflake account.
This URL must include your account identifier . Note that the protocol (https://) and port number are optional.
bufferingHints?
Type:
IResolvable | Snowflake
(optional)
Describes the buffering to perform before delivering data to the Snowflake destination.
If you do not specify any value, Firehose uses the default values.
cloudWatchLoggingOptions?
Type:
IResolvable | Cloud
(optional)
contentColumnName?
Type:
string
(optional)
The name of the record content column.
dataLoadingOption?
Type:
string
(optional)
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.
database?
Type:
string
(optional)
All data in Snowflake is maintained in databases.
keyPassphrase?
Type:
string
(optional)
Passphrase to decrypt the private key when the key is encrypted.
For information, see Using Key Pair Authentication & Key Rotation .
metaDataColumnName?
Type:
string
(optional)
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" }
privateKey?
Type:
string
(optional)
The private key used to encrypt your Snowflake client.
For information, see Using Key Pair Authentication & Key Rotation .
processingConfiguration?
Type:
IResolvable | Processing
(optional)
retryOptions?
Type:
IResolvable | Snowflake
(optional)
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
roleArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the Snowflake role.
s3BackupMode?
Type:
string
(optional)
Choose an S3 backup mode.
s3Configuration?
Type:
IResolvable | S3
(optional)
schema?
Type:
string
(optional)
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.
secretsManagerConfiguration?
Type:
IResolvable | Secrets
(optional)
The configuration that defines how you access secrets for Snowflake.
snowflakeRoleConfiguration?
Type:
IResolvable | Snowflake
(optional)
Optionally configure a Snowflake role.
Otherwise the default user role will be used.
snowflakeVpcConfiguration?
Type:
IResolvable | Snowflake
(optional)
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
table?
Type:
string
(optional)
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
user?
Type:
string
(optional)
User login name for the Snowflake account.