Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.061Z")
@Stability(Stable)
public interface EncryptionConfiguration
extends software.amazon.jsii.JsiiSerializable

Encryption Configuration of the S3 bucket.

Example:

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Athena Start Query")
         .queryString(JsonPath.format("select contacts where year={};", JsonPath.stringAt("$.year")))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("interactions")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("mybucket")
                         .objectKey("myprefix")
                         .build())
                 .build())
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getEncryptionOption

@Stability(Stable)
@NotNull
EncryptionOption getEncryptionOption()

Type of S3 server-side encryption enabled.

Default: EncryptionOption.S3_MANAGED

getEncryptionKey

@Stability(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(Stable)
static EncryptionConfiguration.Builder builder()

Returns:

a EncryptionConfiguration.Builder of EncryptionConfiguration