interface ExtendedS3DestinationConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_ExtendedS3DestinationConfigurationProperty`
Java	`software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty`
Python	`aws_cdk.aws_kinesisfirehose.CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kinesisfirehose` » `CfnDeliveryStream` » `ExtendedS3DestinationConfigurationProperty`

The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.

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 extendedS3DestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty = {
  bucketArn: 'bucketArn',
  roleArn: 'roleArn',

  // the properties below are optional
  bufferingHints: {
    intervalInSeconds: 123,
    sizeInMBs: 123,
  },
  cloudWatchLoggingOptions: {
    enabled: false,
    logGroupName: 'logGroupName',
    logStreamName: 'logStreamName',
  },
  compressionFormat: 'compressionFormat',
  customTimeZone: 'customTimeZone',
  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',
  fileExtension: 'fileExtension',
  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
bucketArn	`string`	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
roleArn	`string`	The Amazon Resource Name (ARN) of the AWS credentials.
bufferingHints?	`IResolvable` `\|` `BufferingHintsProperty`	The buffering option.
cloudWatchLoggingOptions?	`IResolvable` `\|` `CloudWatchLoggingOptionsProperty`	The Amazon CloudWatch logging options for your Firehose stream.
compressionFormat?	`string`	The compression format.
customTimeZone?	`string`	The time zone you prefer.
dataFormatConversionConfiguration?	`IResolvable` `\|` `DataFormatConversionConfigurationProperty`	The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
dynamicPartitioningConfiguration?	`IResolvable` `\|` `DynamicPartitioningConfigurationProperty`	The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.
encryptionConfiguration?	`IResolvable` `\|` `EncryptionConfigurationProperty`	The encryption configuration for the Kinesis Data Firehose delivery stream.
errorOutputPrefix?	`string`	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
fileExtension?	`string`	Specify a file extension.
prefix?	`string`	The `YYYY/MM/DD/HH` time format prefix is automatically used for delivered Amazon S3 files.
processingConfiguration?	`IResolvable` `\|` `ProcessingConfigurationProperty`	The data processing configuration for the Kinesis Data Firehose delivery stream.
s3BackupConfiguration?	`IResolvable` `\|` `S3DestinationConfigurationProperty`	The configuration for backup in Amazon S3.
s3BackupMode?	`string`	The Amazon S3 backup mode.

bucketArn

Type: string

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

roleArn

Type: string

The Amazon Resource Name (ARN) of the AWS credentials.

For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

bufferingHints?

Type: IResolvable | BufferingHintsProperty (optional)

The buffering option.

cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

The Amazon CloudWatch logging options for your Firehose stream.

compressionFormat?

Type: string (optional)

The compression format.

If no value is specified, the default is UNCOMPRESSED .

customTimeZone?

Type: string (optional)

The time zone you prefer.

UTC is the default.

dataFormatConversionConfiguration?

Type: IResolvable | DataFormatConversionConfigurationProperty (optional)

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

dynamicPartitioningConfiguration?

Type: IResolvable | DynamicPartitioningConfigurationProperty (optional)

The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.

encryptionConfiguration?

Type: IResolvable | EncryptionConfigurationProperty (optional)

The encryption configuration for the Kinesis Data Firehose delivery stream.

The default value is NoEncryption .

errorOutputPrefix?

Type: string (optional)

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.

This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects .

fileExtension?

Type: string (optional)

Specify a file extension.

It will override the default file extension

prefix?

Type: string (optional)

The YYYY/MM/DD/HH time format prefix is automatically used for delivered Amazon S3 files.

For more information, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

processingConfiguration?

Type: IResolvable | ProcessingConfigurationProperty (optional)

The data processing configuration for the Kinesis Data Firehose delivery stream.

s3BackupConfiguration?

Type: IResolvable | S3DestinationConfigurationProperty (optional)

The configuration for backup in Amazon S3.

s3BackupMode?

Type: string (optional)

The Amazon S3 backup mode.

After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.