AWS CDK Reference

Appearance

v2.275.0

CommonDestinationS3Props Struct ​

Common properties for defining a backup, intermediary, or final S3 destination for a Amazon Data Firehose delivery stream.

Source
aws-kinesisfirehose/lib/common.ts
Type last changed
v2.239.0 · 19 Feb 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_kinesisfirehose as kinesisfirehose } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';

declare const compression: kinesisfirehose.Compression;
declare const key: kms.Key;
declare const size: cdk.Size;
const commonDestinationS3Props: kinesisfirehose.CommonDestinationS3Props = {
  bufferingInterval: cdk.Duration.minutes(30),
  bufferingSize: size,
  compression: compression,
  dataOutputPrefix: 'dataOutputPrefix',
  encryptionKey: key,
  errorOutputPrefix: 'errorOutputPrefix',
};

Properties ​

bufferingIntervaloptionalDurationbuffering_intervaloptionalDurationbufferingIntervaloptionalDurationBufferingIntervaloptionalDurationBufferingIntervaloptionalDuration= Duration.seconds(300)#
The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.

Minimum: Duration.seconds(0) when dynamic partitioning is disabled, Duration.seconds(60) when it is enabled Maximum: Duration.seconds(900)

bufferingSizeoptionalSizebuffering_sizeoptionalSizebufferingSizeoptionalSizeBufferingSizeoptionalSizeBufferingSizeoptionalSize#
The size of the buffer that Amazon Data Firehose uses for incoming data before delivering it to the S3 bucket.

Default: Size.mebibytes(5) when record data format conversion or dynamic partitioning is disabled, Size.mebibytes(128) when it is enabled

Minimum: Size.mebibytes(1) when record data format conversion or dynamic partitioning is disabled, Size.mebibytes(64) when it is enabled Maximum: Size.mebibytes(128)

compressionoptionalCompressioncompressionoptionalCompressioncompressionoptionalCompressionCompressionoptionalCompressionCompressionoptionalCompression= UNCOMPRESSED#
The type of compression that Amazon Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

dataOutputPrefixoptionalstringdata_output_prefixoptionalstrdataOutputPrefixoptionalStringDataOutputPrefixoptionalstringDataOutputPrefixoptional*string= "YYYY/MM/DD/HH/"#
A prefix that Amazon Data Firehose evaluates and adds to records before writing them to S3.

This prefix appears immediately following the bucket name.

encryptionKeyoptionalIKeyencryption_keyoptionalIKeyencryptionKeyoptionalIKeyEncryptionKeyoptionalIKeyEncryptionKeyoptionalIKey#
The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.

Default: Data is not encrypted.

errorOutputPrefixoptionalstringerror_output_prefixoptionalstrerrorOutputPrefixoptionalStringErrorOutputPrefixoptionalstringErrorOutputPrefixoptional*string#
A prefix that Amazon Data Firehose evaluates and adds to failed records before writing them to S3.

Default: See the documentation above

This prefix appears immediately following the bucket name.