Package software.amazon.awssdk.services.athena.model

Class EncryptionConfiguration

java.lang.Object

software.amazon.awssdk.services.athena.model.EncryptionConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EncryptionConfiguration.Builder,EncryptionConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class EncryptionConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EncryptionConfiguration.Builder,EncryptionConfiguration>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EncryptionConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptionConfiguration.Builder	builder()
EncryptionOption	encryptionOption()	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.
String	encryptionOptionAsString()	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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKey()	For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EncryptionConfiguration.Builder>	serializableBuilderClass()
EncryptionConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

encryptionOption

public final EncryptionOption encryptionOption()

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.

If the service returns an enum value that is not available in the current SDK version, encryptionOption will return EncryptionOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionOptionAsString().

Returns:

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:

EncryptionOption

encryptionOptionAsString

public final String encryptionOptionAsString()

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.

If the service returns an enum value that is not available in the current SDK version, encryptionOption will return EncryptionOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionOptionAsString().

Returns:

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:

EncryptionOption

kmsKey

public final String kmsKey()

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

Returns:

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

toBuilder

public EncryptionConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EncryptionConfiguration.Builder,EncryptionConfiguration>

builder

public static EncryptionConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends EncryptionConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo