Package software.amazon.awscdk.services.s3

Enum BucketEncryption

java.lang.Object

java.lang.Enum<BucketEncryption>

software.amazon.awscdk.services.s3.BucketEncryption

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:16.216Z")
@Stability(Stable)
public enum BucketEncryption
extends Enum<BucketEncryption>

What kind of server-side encryption to apply to this bucket.

Example:

 import software.amazon.awscdk.services.s3.BucketEncryption;
 App app = App.Builder.create()
         .defaultStackSynthesizer(AppStagingSynthesizer.defaultResources(DefaultResourcesOptions.builder()
                 .appId("my-app-id")
                 .stagingBucketEncryption(BucketEncryption.S3_MANAGED)
                 .fileAssetPublishingRole(BootstrapRole.fromRoleArn("arn:aws:iam::123456789012:role/S3Access"))
                 .imageAssetPublishingRole(BootstrapRole.fromRoleArn("arn:aws:iam::123456789012:role/ECRAccess"))
                 .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
DSSE	Double server-side encryption with a KMS key managed by the user.
DSSE_MANAGED	Double server-side KMS encryption with a master key managed by KMS.
KMS	Server-side encryption with a KMS key managed by the user.
KMS_MANAGED	Server-side KMS encryption with a master key managed by KMS.
S3_MANAGED	Server-side encryption with a master key managed by S3.
UNENCRYPTED	Deprecated. S3 applies server-side encryption with SSE-S3 for every bucket that default encryption is not configured.

Method Summary

Modifier and Type	Method	Description
static BucketEncryption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BucketEncryption[]	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

UNENCRYPTED

@Stability(Deprecated)
@Deprecated
public static final BucketEncryption UNENCRYPTED

Deprecated.

S3 applies server-side encryption with SSE-S3 for every bucket that default encryption is not configured.

(deprecated) Previous option.

Buckets can not be unencrypted now.

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html

KMS_MANAGED

@Stability(Stable)
public static final BucketEncryption KMS_MANAGED

Server-side KMS encryption with a master key managed by KMS.

S3_MANAGED

@Stability(Stable)
public static final BucketEncryption S3_MANAGED

Server-side encryption with a master key managed by S3.

KMS

@Stability(Stable)
public static final BucketEncryption KMS

Server-side encryption with a KMS key managed by the user.

If encryptionKey is specified, this key will be used, otherwise, one will be defined.

DSSE_MANAGED

@Stability(Stable)
public static final BucketEncryption DSSE_MANAGED

Double server-side KMS encryption with a master key managed by KMS.

DSSE

@Stability(Stable)
public static final BucketEncryption DSSE

Double server-side encryption with a KMS key managed by the user.

If encryptionKey is specified, this key will be used, otherwise, one will be defined.

Method Details

values

public static BucketEncryption[] 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 BucketEncryption 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