enum BackupMode

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

Options for S3 record backup of a delivery stream.

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',
      },
    }),
});

Members

Name	Description
ALL	All records are backed up.
FAILED	Only records that failed to deliver or transform are backed up.

---

ALL

All records are backed up.

---

FAILED

Only records that failed to deliver or transform are backed up.