Package software.amazon.awscdk.services.athena

Interface CfnWorkGroup.EncryptionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroup.EncryptionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnWorkGroup

@Stability(Stable)
public static interface CfnWorkGroup.EncryptionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS ) and key information.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.athena.*;
 EncryptionConfigurationProperty encryptionConfigurationProperty = EncryptionConfigurationProperty.builder()
         .encryptionOption("encryptionOption")
         // the properties below are optional
         .kmsKey("kmsKey")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWorkGroup.EncryptionConfigurationProperty.Builder	builder()
String	getEncryptionOption()	Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys ( SSE_S3 ), server-side encryption with KMS-managed keys ( SSE_KMS ), or client-side encryption with KMS-managed keys ( CSE_KMS ) is used.
default String	getKmsKey()	For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncryptionOption

@Stability(Stable)
@NotNull
String getEncryptionOption()

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys ( SSE_S3 ), server-side encryption with KMS-managed keys ( SSE_KMS ), or client-side encryption with KMS-managed keys ( CSE_KMS ) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html#cfn-athena-workgroup-encryptionconfiguration-encryptionoption

getKmsKey

@Stability(Stable)
@Nullable
default String getKmsKey()

For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html#cfn-athena-workgroup-encryptionconfiguration-kmskey

builder

@Stability(Stable)
static CfnWorkGroup.EncryptionConfigurationProperty.Builder builder()

Returns:

a CfnWorkGroup.EncryptionConfigurationProperty.Builder of CfnWorkGroup.EncryptionConfigurationProperty