Interface DestinationS3BackupProps
- All Superinterfaces:
CommonDestinationS3Props
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
DestinationS3BackupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-07-12T19:34:12.116Z")
@Stability(Experimental)
public interface DestinationS3BackupProps
extends software.amazon.jsii.JsiiSerializable, CommonDestinationS3Props
(experimental) 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). Bucket bucket; // Explicitly provide an S3 bucket to which all source records will be backed up. Bucket backupBucket; DeliveryStream.Builder.create(this, "Delivery Stream Backup All") .destinations(List.of( S3Bucket.Builder.create(bucket) .s3Backup(DestinationS3BackupProps.builder() .mode(BackupMode.ALL) .build()) .build())) .build(); DeliveryStream.Builder.create(this, "Delivery Stream Backup All Explicit Bucket") .destinations(List.of( S3Bucket.Builder.create(bucket) .s3Backup(DestinationS3BackupProps.builder() .bucket(backupBucket) .build()) .build())) .build(); // Explicitly provide an S3 prefix under which all source records will be backed up. // Explicitly provide an S3 prefix under which all source records will be backed up. DeliveryStream.Builder.create(this, "Delivery Stream Backup All Explicit Prefix") .destinations(List.of( S3Bucket.Builder.create(bucket) .s3Backup(DestinationS3BackupProps.builder() .mode(BackupMode.ALL) .dataOutputPrefix("mybackup") .build()) .build())) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forDestinationS3BackupProps
static final class
An implementation forDestinationS3BackupProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default IBucket
(experimental) The S3 bucket that will store data and failed records.default Boolean
(experimental) If true, log errors when data transformation or data delivery fails.default ILogGroup
(experimental) The CloudWatch log group where log streams will be created to hold error logs.default BackupMode
getMode()
(experimental) Indicates the mode by which incoming records should be backed up to S3, if any.Methods inherited from interface software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.CommonDestinationS3Props
getBufferingInterval, getBufferingSize, getCompression, getDataOutputPrefix, getEncryptionKey, getErrorOutputPrefix
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBucket
(experimental) The S3 bucket that will store data and failed records.Default: - If `mode` is set to `BackupMode.ALL` or `BackupMode.FAILED`, a bucket will be created for you.
-
getLogging
(experimental) If true, log errors when data transformation or data delivery fails.If
logGroup
is provided, this will be implicitly set totrue
.Default: true - errors are logged.
-
getLogGroup
(experimental) The CloudWatch log group where log streams will be created to hold error logs.Default: - if `logging` is set to `true`, a log group will be created for you.
-
getMode
(experimental) Indicates the mode by which incoming records should be backed up to S3, if any.If
bucket
is provided, this will be implicitly set toBackupMode.ALL
.Default: - If `bucket` is provided, the default will be `BackupMode.ALL`. Otherwise, source records are not backed up to S3.
-
builder
- Returns:
- a
DestinationS3BackupProps.Builder
ofDestinationS3BackupProps
-