interface DestinationS3BackupProps

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.DestinationS3BackupProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#DestinationS3BackupProps`
Java	`software.amazon.awscdk.services.kinesisfirehose.DestinationS3BackupProps`
Python	`aws_cdk.aws_kinesisfirehose.DestinationS3BackupProps`
TypeScript (source)	`aws-cdk-lib` » `aws_kinesisfirehose` » `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

// Enable backup of all source records (to an S3 bucket created by CDK).
declare const bucket: s3.Bucket;
new firehose.DeliveryStream(this, 'Delivery Stream Backup All', {
  destination:
    new firehose.S3Bucket(bucket, {
      s3Backup: {
        mode: firehose.BackupMode.ALL,
      },
    }),
});
// Explicitly provide an S3 bucket to which all source records will be backed up.
declare const backupBucket: s3.Bucket;
new firehose.DeliveryStream(this, 'Delivery Stream Backup All Explicit Bucket', {
  destination:
    new firehose.S3Bucket(bucket, {
      s3Backup: {
        bucket: backupBucket,
      },
    }),
});
// Explicitly provide an S3 prefix under which all source records will be backed up.
new firehose.DeliveryStream(this, 'Delivery Stream Backup All Explicit Prefix', {
  destination:
    new firehose.S3Bucket(bucket, {
      s3Backup: {
        mode: firehose.BackupMode.ALL,
        dataOutputPrefix: 'mybackup',
      },
    }),
});

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 Amazon Data Firehose uses for incoming data before delivering it to the S3 bucket.
compression?	`Compression`	The type of compression that Amazon Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
dataOutputPrefix?	`string`	A prefix that Amazon 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 Amazon Data Firehose evaluates and adds to failed records before writing them to S3.
loggingConfig?	`ILoggingConfig`	Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.
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(0) Maximum: Duration.seconds(900)

bufferingSize?

Type: Size (optional, default: Size.mebibytes(5) when record data format conversion is disabled, Size.mebibytes(128) when it is enabled)

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

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

compression?

Type: Compression (optional, default: 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.

dataOutputPrefix?

Type: string (optional, default: "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.

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 Amazon Data Firehose evaluates and adds to failed records before writing them to S3.

This prefix appears immediately following the bucket name.

loggingConfig?

Type: ILoggingConfig (optional, default: errors will be logged and a log group will be created for you.)

Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

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.

AWS CDK

2.233.0