Package software.amazon.awscdk.services.kinesisfirehose.destinations.alpha

Enum BackupMode

java.lang.Object

java.lang.Enum<BackupMode>

software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.BackupMode

All Implemented Interfaces:

Serializable, Comparable<BackupMode>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-10T21:57:02.086Z")
@Stability(Experimental)
public enum BackupMode
extends Enum<BackupMode>

(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")
         .destination(
         S3Bucket.Builder.create(bucket)
                 .s3Backup(DestinationS3BackupProps.builder()
                         .mode(BackupMode.ALL)
                         .build())
                 .build())
         .build();
 DeliveryStream.Builder.create(this, "Delivery Stream Backup All Explicit Bucket")
         .destination(
         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")
         .destination(
         S3Bucket.Builder.create(bucket)
                 .s3Backup(DestinationS3BackupProps.builder()
                         .mode(BackupMode.ALL)
                         .dataOutputPrefix("mybackup")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	(experimental) All records are backed up.
FAILED	(experimental) Only records that failed to deliver or transform are backed up.

Method Summary

Modifier and Type	Method	Description
static BackupMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BackupMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

@Stability(Experimental)
public static final BackupMode ALL

(experimental) All records are backed up.

FAILED

@Stability(Experimental)
public static final BackupMode FAILED

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

Method Details

values

public static BackupMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BackupMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null