software.amazon.awscdk.services.stepfunctions.tasks

Interface EncryptionConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EncryptionConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.506Z")
 @Stability(value=Stable)
public interface EncryptionConfiguration
extends software.amazon.jsii.JsiiSerializable

Encryption Configuration 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())
         .build();
 

See Also:

https://docs.aws.amazon.com/athena/latest/APIReference/API_EncryptionConfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EncryptionConfiguration.Builder A builder for EncryptionConfiguration
static class	EncryptionConfiguration.Jsii$Proxy An implementation for EncryptionConfiguration

Method Summary

Modifier and Type	Method and Description
static EncryptionConfiguration.Builder	builder()
default IKey	getEncryptionKey() KMS key ARN or ID.
EncryptionOption	getEncryptionOption() Type of S3 server-side encryption enabled.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEncryptionOption

@Stability(value=Stable)
 @NotNull
EncryptionOption getEncryptionOption()

Type of S3 server-side encryption enabled.

Default: EncryptionOption.S3_MANAGED

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

KMS key ARN or ID.

Default: - No KMS key for Encryption Option SSE_S3 and default master key for Encryption Option SSE_KMS and CSE_KMS

builder

@Stability(value=Stable)
static EncryptionConfiguration.Builder builder()

Returns:

a EncryptionConfiguration.Builder of EncryptionConfiguration