interface SnowflakeDestinationConfigurationProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.SnowflakeDestinationConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_SnowflakeDestinationConfigurationProperty |
Java | software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.SnowflakeDestinationConfigurationProperty |
Python | aws_cdk.aws_kinesisfirehose.CfnDeliveryStream.SnowflakeDestinationConfigurationProperty |
TypeScript | aws-cdk-lib » aws_kinesisfirehose » CfnDeliveryStream » 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 { aws_kinesisfirehose as kinesisfirehose } from 'aws-cdk-lib';
const snowflakeDestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.SnowflakeDestinationConfigurationProperty = {
accountUrl: 'accountUrl',
database: 'database',
privateKey: 'privateKey',
roleArn: 'roleArn',
s3Configuration: {
bucketArn: 'bucketArn',
roleArn: 'roleArn',
// the properties below are optional
bufferingHints: {
intervalInSeconds: 123,
sizeInMBs: 123,
},
cloudWatchLoggingOptions: {
enabled: false,
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
},
compressionFormat: 'compressionFormat',
encryptionConfiguration: {
kmsEncryptionConfig: {
awskmsKeyArn: 'awskmsKeyArn',
},
noEncryptionConfig: 'noEncryptionConfig',
},
errorOutputPrefix: 'errorOutputPrefix',
prefix: 'prefix',
},
schema: 'schema',
table: 'table',
user: 'user',
// the properties below are optional
cloudWatchLoggingOptions: {
enabled: false,
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
},
contentColumnName: 'contentColumnName',
dataLoadingOption: 'dataLoadingOption',
keyPassphrase: 'keyPassphrase',
metaDataColumnName: 'metaDataColumnName',
processingConfiguration: {
enabled: false,
processors: [{
type: 'type',
// the properties below are optional
parameters: [{
parameterName: 'parameterName',
parameterValue: 'parameterValue',
}],
}],
},
retryOptions: {
durationInSeconds: 123,
},
s3BackupMode: 's3BackupMode',
snowflakeRoleConfiguration: {
enabled: false,
snowflakeRole: 'snowflakeRole',
},
snowflakeVpcConfiguration: {
privateLinkVpceId: 'privateLinkVpceId',
},
};
Properties
Name | Type | Description |
---|---|---|
account | string | URL for accessing your Snowflake account. |
database | string | All data in Snowflake is maintained in databases. |
private | string | The private key used to encrypt your Snowflake client. |
role | string | The Amazon Resource Name (ARN) of the Snowflake role. |
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. |
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. |
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. |
key | string | Passphrase to decrypt the private key when the key is encrypted. |
meta | string | The name of the record metadata column. |
processing | IResolvable | Processing | |
retry | IResolvable | Snowflake | The time period where Firehose will retry sending data to the chosen HTTP endpoint. |
s3 | string | Choose an S3 backup mode. |
snowflake | IResolvable | Snowflake | Optionally configure a Snowflake role. |
snowflake | IResolvable | Snowflake | The VPCE ID for Firehose to privately connect with Snowflake. |
accountUrl
Type:
string
URL for accessing your Snowflake account.
This URL must include your account identifier . Note that the protocol (https://) and port number are optional.
database
Type:
string
All data in Snowflake is maintained in databases.
privateKey
Type:
string
The private key used to encrypt your Snowflake client.
For information, see Using Key Pair Authentication & Key Rotation .
roleArn
Type:
string
The Amazon Resource Name (ARN) of the Snowflake role.
s3Configuration
Type:
IResolvable
|
S3
schema
Type:
string
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.
table
Type:
string
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
user
Type:
string
User login name for the Snowflake account.
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.
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)
The name of the record metadata column.
processingConfiguration?
Type:
IResolvable
|
Processing
(optional)
retryOptions?
Type:
IResolvable
|
Snowflake
(optional)
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
s3BackupMode?
Type:
string
(optional)
Choose an S3 backup mode.
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