Package 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("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	Description
static interface	SSESpecification.Builder

Method Summary

Modifier and Type	Method	Description
static SSESpecification.Builder	builder()
Boolean	enabled()	Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsMasterKeyId()	The KMS key that 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()
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

enabled

public final Boolean enabled()

Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.

Returns:

Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.

sseType

public final SSEType sseType()

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by 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. The only supported value is:

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

See Also:

SSEType

sseTypeAsString

public final String sseTypeAsString()

Server-side encryption type. The only supported value is:

• KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by 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. The only supported value is:

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

See Also:

SSEType

kmsMasterKeyId

public final String kmsMasterKeyId()

The KMS key that should be used for the KMS encryption. To specify a key, 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 key alias/aws/dynamodb.

Returns:

The KMS key that should be used for the KMS encryption. To specify a key, 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 key alias/aws/dynamodb.

toBuilder

public SSESpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SSESpecification.Builder,SSESpecification>

builder

public static SSESpecification.Builder builder()

serializableBuilderClass

public static Class<? extends SSESpecification.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