Class SSEDescription

java.lang.Object
software.amazon.awssdk.services.dynamodb.model.SSEDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SSEDescription.Builder,SSEDescription>
@Generated("software.amazon.awssdk:codegen") public final class SSEDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SSEDescription.Builder,SSEDescription>

The description of the server-side encryption status on the specified table.

See Also:

  • Method Details

    • status

      public final SSEStatus status()

      Represents the current state of server-side encryption. The only supported values are:

      • ENABLED - Server-side encryption is enabled.

      • UPDATING - Server-side encryption is being updated.

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

      Returns:
      Represents the current state of server-side encryption. The only supported values are:

      • ENABLED - Server-side encryption is enabled.

      • UPDATING - Server-side encryption is being updated.

      See Also:

    • statusAsString

      public final String statusAsString()

      Represents the current state of server-side encryption. The only supported values are:

      • ENABLED - Server-side encryption is enabled.

      • UPDATING - Server-side encryption is being updated.

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

      Returns:
      Represents the current state of server-side encryption. The only supported values are:

      • ENABLED - Server-side encryption is enabled.

      • UPDATING - Server-side encryption is being updated.

      See Also:

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

    • kmsMasterKeyArn

      public final String kmsMasterKeyArn()

      The KMS key ARN used for the KMS encryption.

      Returns:
      The KMS key ARN used for the KMS encryption.

    • inaccessibleEncryptionDateTime

      public final Instant inaccessibleEncryptionDateTime()

      Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

      Returns:
      Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

    • toBuilder

      public SSEDescription.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<SSEDescription.Builder,SSEDescription>
      Returns:
      a builder for type T

    • builder

      public static SSEDescription.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.