Package software.amazon.awscdk.services.stepfunctions.tasks

Enum EncryptionOption

java.lang.Object

java.lang.Enum<EncryptionOption>

software.amazon.awscdk.services.stepfunctions.tasks.EncryptionOption

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:38.128Z")
@Stability(Stable)
public enum EncryptionOption
extends Enum<EncryptionOption>

Encryption Options of the S3 bucket.

Example:

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Start Athena Query")
         .queryString(JsonPath.stringAt("$.queryString"))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("mydatabase")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("query-results-bucket")
                         .objectKey("folder")
                         .build())
                 .build())
         .executionParameters(List.of("param1", "param2"))
         .build();
 

See Also:

• https://docs.aws.amazon.com/athena/latest/APIReference/API_EncryptionConfiguration.html#athena-Type-EncryptionConfiguration-EncryptionOption

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
CLIENT_SIDE_KMS	Client-side encryption (CSE) with an AWS KMS key managed by the account owner.
KMS	Server-side encryption (SSE) with an AWS KMS key managed by the account owner.
S3_MANAGED	Server side encryption (SSE) with an Amazon S3-managed key.

Method Summary

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

S3_MANAGED

@Stability(Stable)
public static final EncryptionOption S3_MANAGED

Server side encryption (SSE) with an Amazon S3-managed key.

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html

KMS

@Stability(Stable)
public static final EncryptionOption KMS

Server-side encryption (SSE) with an AWS KMS key managed by the account owner.

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html

CLIENT_SIDE_KMS

@Stability(Stable)
public static final EncryptionOption CLIENT_SIDE_KMS

Client-side encryption (CSE) with an AWS KMS key managed by the account owner.

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html

Method Details

values

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