interface DestinationConfig
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.KinesisFirehose.DestinationConfig |
Java | software.amazon.awscdk.services.kinesisfirehose.DestinationConfig |
Python | aws_cdk.aws_kinesisfirehose.DestinationConfig |
TypeScript (source) | @aws-cdk/aws-kinesisfirehose » DestinationConfig |
Obtainable from
S3
.bind()
A Kinesis Data Firehose delivery stream destination configuration.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kinesisfirehose from '@aws-cdk/aws-kinesisfirehose';
import * as cdk from '@aws-cdk/core';
declare const dependable: cdk.IDependable;
const destinationConfig: kinesisfirehose.DestinationConfig = {
dependables: [dependable],
extendedS3DestinationConfiguration: {
bucketArn: 'bucketArn',
roleArn: 'roleArn',
// the properties below are optional
bufferingHints: {
intervalInSeconds: 123,
sizeInMBs: 123,
},
cloudWatchLoggingOptions: {
enabled: false,
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
},
compressionFormat: 'compressionFormat',
dataFormatConversionConfiguration: {
enabled: false,
inputFormatConfiguration: {
deserializer: {
hiveJsonSerDe: {
timestampFormats: ['timestampFormats'],
},
openXJsonSerDe: {
caseInsensitive: false,
columnToJsonKeyMappings: {
columnToJsonKeyMappingsKey: 'columnToJsonKeyMappings',
},
convertDotsInJsonKeysToUnderscores: false,
},
},
},
outputFormatConfiguration: {
serializer: {
orcSerDe: {
blockSizeBytes: 123,
bloomFilterColumns: ['bloomFilterColumns'],
bloomFilterFalsePositiveProbability: 123,
compression: 'compression',
dictionaryKeyThreshold: 123,
enablePadding: false,
formatVersion: 'formatVersion',
paddingTolerance: 123,
rowIndexStride: 123,
stripeSizeBytes: 123,
},
parquetSerDe: {
blockSizeBytes: 123,
compression: 'compression',
enableDictionaryCompression: false,
maxPaddingBytes: 123,
pageSizeBytes: 123,
writerVersion: 'writerVersion',
},
},
},
schemaConfiguration: {
catalogId: 'catalogId',
databaseName: 'databaseName',
region: 'region',
roleArn: 'roleArn',
tableName: 'tableName',
versionId: 'versionId',
},
},
dynamicPartitioningConfiguration: {
enabled: false,
retryOptions: {
durationInSeconds: 123,
},
},
encryptionConfiguration: {
kmsEncryptionConfig: {
awskmsKeyArn: 'awskmsKeyArn',
},
noEncryptionConfig: 'noEncryptionConfig',
},
errorOutputPrefix: 'errorOutputPrefix',
prefix: 'prefix',
processingConfiguration: {
enabled: false,
processors: [{
type: 'type',
// the properties below are optional
parameters: [{
parameterName: 'parameterName',
parameterValue: 'parameterValue',
}],
}],
},
s3BackupConfiguration: {
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',
},
s3BackupMode: 's3BackupMode',
},
};
Properties
Name | Type | Description |
---|---|---|
dependables? | IDependable [] | Any resources that were created by the destination when binding it to the stack that must be deployed before the delivery stream is deployed. |
extended | Extended | S3 destination configuration properties. |
dependables?
Type:
IDependable
[]
(optional, default: [])
Any resources that were created by the destination when binding it to the stack that must be deployed before the delivery stream is deployed.
extendedS3DestinationConfiguration?
Type:
Extended
(optional, default: S3 destination is not used.)
S3 destination configuration properties.