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>

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-14T20:30:48.037Z")
 @Stability(value=Stable)
public enum BucketEncryption
extends Enum<BucketEncryption>

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

Example:

 Bucket bucket = Bucket.Builder.create(this, "MyEncryptedBucket")
         .encryption(BucketEncryption.KMS)
         .build();
 // you can access the encryption key:
 assert(bucket.getEncryptionKey() instanceof Key);
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
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 Objects in the bucket are not encrypted.

Method Summary

Modifier and Type	Method and 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNENCRYPTED

@Stability(value=Stable)
public static final BucketEncryption UNENCRYPTED

Objects in the bucket are not encrypted.

KMS_MANAGED

@Stability(value=Stable)
public static final BucketEncryption KMS_MANAGED

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

S3_MANAGED

@Stability(value=Stable)
public static final BucketEncryption S3_MANAGED

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

KMS

@Stability(value=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.

Method Detail

values

public static BucketEncryption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BucketEncryption c : BucketEncryption.values())
    System.out.println(c);

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