@aws-cdk_aws-kinesisfirehose-alpha.DestinationConfig

interface DestinationConfig ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.Alpha.DestinationConfig
Gogithub.com/aws/aws-cdk-go/awscdkkinesisfirehosealpha/v2#DestinationConfig
Javasoftware.amazon.awscdk.services.kinesisfirehose.alpha.DestinationConfig
Pythonaws_cdk.aws_kinesisfirehose_alpha.DestinationConfig
TypeScript (source)@aws-cdk/aws-kinesisfirehose-alpha ยป DestinationConfig

Obtainable from S3Bucket.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_alpha from '@aws-cdk/aws-kinesisfirehose-alpha';
import * as constructs from 'constructs';

declare const dependable: constructs.IDependable;
const destinationConfig: kinesisfirehose_alpha.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

NameTypeDescription
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.
extendedS3DestinationConfiguration?๐Ÿ”นExtendedS3DestinationConfigurationPropertyS3 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: ExtendedS3DestinationConfigurationProperty (optional, default: S3 destination is not used.)

S3 destination configuration properties.