software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.BackupMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kinesisfirehose-destinations-alpha Show documentation

CDK Destinations Constructs for AWS Kinesis Firehose

There is a newer version: 2.167.1-alpha.0

Show newest version

package software.amazon.awscdk.services.kinesisfirehose.destinations.alpha;

/**
 * (experimental) Options for S3 record backup of a delivery stream.
 * 
 * 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();
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-19T18:12:10.244Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.$Module.class, fqn = "@aws-cdk/aws-kinesisfirehose-destinations-alpha.BackupMode")
public enum BackupMode {
    /**
     * (experimental) All records are backed up.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    ALL,
    /**
     * (experimental) Only records that failed to deliver or transform are backed up.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    FAILED,
}