interface DestinationS3BackupProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.KinesisFirehose.Destinations.DestinationS3BackupProps
Java	software.amazon.awscdk.services.kinesisfirehose.destinations.DestinationS3BackupProps
Python	aws_cdk.aws_kinesisfirehose_destinations.DestinationS3BackupProps
TypeScript (source)	@aws-cdk/aws-kinesisfirehose-destinations » DestinationS3BackupProps

Properties for defining an S3 backup destination.

S3 backup is available for all destinations, regardless of whether the final destination is S3 or not.

Example

#!/usr/bin/env node

Properties

Name	Type	Description
bucket?🔹	IBucket	The S3 bucket that will store data and failed records.
bufferingInterval?🔹	Duration	The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.
bufferingSize?🔹	Size	The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket.
compression?🔹	Compression	The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
dataOutputPrefix?🔹	string	A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3.
encryptionKey?🔹	IKey	The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.
errorOutputPrefix?🔹	string	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
logGroup?🔹	ILogGroup	The CloudWatch log group where log streams will be created to hold error logs.
logging?🔹	boolean	If true, log errors when data transformation or data delivery fails.
mode?🔹	BackupMode	Indicates the mode by which incoming records should be backed up to S3, if any.

---

bucket?🔹

Type: IBucket (optional, default: If mode is set to BackupMode.ALL or BackupMode.FAILED, a bucket will be created for you.)

The S3 bucket that will store data and failed records.

---

bufferingInterval?🔹

Type: Duration (optional, default: Duration.seconds(300))

The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.

Minimum: Duration.seconds(60) Maximum: Duration.seconds(900)

---

bufferingSize?🔹

Type: Size (optional, default: Size.mebibytes(5))

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

Minimum: Size.mebibytes(1) Maximum: Size.mebibytes(128)

---

compression?🔹

Type: Compression (optional, default: UNCOMPRESSED)

The type of compression that Kinesis 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.

---

dataOutputPrefix?🔹

Type: string (optional, default: "YYYY/MM/DD/HH")

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

This prefix appears immediately following the bucket name.

See also: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

---

encryptionKey?🔹

Type: IKey (optional, default: Data is not encrypted.)

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

---

errorOutputPrefix?🔹

Type: string (optional, default: "YYYY/MM/DD/HH")

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.

See also: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

---

logGroup?🔹

Type: ILogGroup (optional, default: if logging is set to true, a log group will be created for you.)

The CloudWatch log group where log streams will be created to hold error logs.

---

logging?🔹

Type: boolean (optional, default: true - errors are logged.)

If true, log errors when data transformation or data delivery fails.

If logGroup is provided, this will be implicitly set to true.

---

mode?🔹

Type: BackupMode (optional, default: If bucket is provided, the default will be BackupMode.ALL. Otherwise, source records are not backed up to S3.)

Indicates the mode by which incoming records should be backed up to S3, if any.

If bucket is provided, this will be implicitly set to BackupMode.ALL.