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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.