@aws-cdk_aws-kinesisfirehose-destinations-alpha.DestinationS3BackupProps

interface DestinationS3BackupProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.Destinations.Alpha.DestinationS3BackupProps
Gogithub.com/aws/aws-cdk-go/awscdkkinesisfirehosedestinationsalpha/v2#DestinationS3BackupProps
Javasoftware.amazon.awscdk.services.kinesisfirehose.destinations.alpha.DestinationS3BackupProps
Pythonaws_cdk.aws_kinesisfirehose_destinations_alpha.DestinationS3BackupProps
TypeScript (source)@aws-cdk/aws-kinesisfirehose-destinations-alpha ยป 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', {
  destinations: [
    new destinations.S3Bucket(bucket, {
      s3Backup: {
        mode: destinations.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', {
  destinations: [
    new destinations.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', {
  destinations: [
    new destinations.S3Bucket(bucket, {
      s3Backup: {
        mode: destinations.BackupMode.ALL,
        dataOutputPrefix: 'mybackup',
      },
    }),
  ],
});

Properties

NameTypeDescription
bucket?๐Ÿ”นIBucketThe S3 bucket that will store data and failed records.
bufferingInterval?๐Ÿ”นDurationThe length of time that Firehose buffers incoming data before delivering it to the S3 bucket.
bufferingSize?๐Ÿ”นSizeThe size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket.
compression?๐Ÿ”นCompressionThe type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
dataOutputPrefix?๐Ÿ”นstringA prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3.
encryptionKey?๐Ÿ”นIKeyThe AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.
errorOutputPrefix?๐Ÿ”นstringA prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
logGroup?๐Ÿ”นILogGroupThe CloudWatch log group where log streams will be created to hold error logs.
logging?๐Ÿ”นbooleanIf true, log errors when data transformation or data delivery fails.
mode?๐Ÿ”นBackupModeIndicates 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.