Class ServerSideEncryptionUpdateDetails

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

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.

See Also:

  • Method Details

    • message

      public final String message()

      Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

      Returns:
      Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

    • oldKmsKeyId

      public final String oldKmsKeyId()

      The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

      Returns:
      The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

    • updateStatus

      public final ServerSideEncryptionUpdateStatus updateStatus()

      Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

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

      Returns:
      Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.
      See Also:

    • updateStatusAsString

      public final String updateStatusAsString()

      Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

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

      Returns:
      Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.
      See Also:

    • toBuilder

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

    • builder

      public static ServerSideEncryptionUpdateDetails.Builder builder()

    • serializableBuilderClass

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