software.amazon.awssdk.services.dynamodb.model

Class SSESpecification

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.SSESpecification

All Implemented Interfaces:

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

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

Represents the settings used to enable server-side encryption.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SSESpecification.Builder

Method Summary

Modifier and Type	Method and Description
static SSESpecification.Builder	builder()
Boolean	enabled() Indicates whether server-side encryption is enabled (true) or disabled (false) on the table.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsMasterKeyId() The KMS Master Key (CMK) which should be used for the KMS encryption.
List<SdkField<?>>	sdkFields()
static Class<? extends SSESpecification.Builder>	serializableBuilderClass()
SSEType	sseType() Server-side encryption type:
String	sseTypeAsString() Server-side encryption type:
SSESpecification.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

enabled

public Boolean enabled()

Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

Returns:

Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

sseType

public SSEType sseType()

Server-side encryption type:

• AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

• KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

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

Returns:

Server-side encryption type:

• AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

• KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

See Also:

SSEType

sseTypeAsString

public String sseTypeAsString()

Server-side encryption type:

• AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

• KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

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

Returns:

Server-side encryption type:

• AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

• KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

See Also:

SSEType

kmsMasterKeyId

public String kmsMasterKeyId()

The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS Master Key alias/aws/dynamodb.

Returns:

The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS Master Key alias/aws/dynamodb.

toBuilder

public SSESpecification.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SSESpecification.Builder,SSESpecification>

Returns:

a builder for type T

builder

public static SSESpecification.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.