Class EncryptionConfigurationDetails

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

The encryption configuration of your IAM Identity Center instance, including the key type, KMS key ARN, and current encryption status.

See Also:

  • Method Details

    • keyType

      public final KmsKeyType keyType()

      The type of KMS key used for encryption.

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

      Returns:
      The type of KMS key used for encryption.
      See Also:

    • keyTypeAsString

      public final String keyTypeAsString()

      The type of KMS key used for encryption.

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

      Returns:
      The type of KMS key used for encryption.
      See Also:

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the KMS key currently used to encrypt data in your IAM Identity Center instance.

      Returns:
      The ARN of the KMS key currently used to encrypt data in your IAM Identity Center instance.

    • encryptionStatus

      public final KmsKeyStatus encryptionStatus()

      The current status of encryption configuration.

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

      Returns:
      The current status of encryption configuration.
      See Also:

    • encryptionStatusAsString

      public final String encryptionStatusAsString()

      The current status of encryption configuration.

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

      Returns:
      The current status of encryption configuration.
      See Also:

    • encryptionStatusReason

      public final String encryptionStatusReason()

      Provides additional context about the current encryption status. This field is particularly useful when the encryption status is UPDATE_FAILED. When encryption configuration update fails, this field contains information about the cause, which may include KMS key access issues, key not found errors, invalid key configuration, key in an invalid state, or a disabled key.

      Returns:
      Provides additional context about the current encryption status. This field is particularly useful when the encryption status is UPDATE_FAILED. When encryption configuration update fails, this field contains information about the cause, which may include KMS key access issues, key not found errors, invalid key configuration, key in an invalid state, or a disabled key.

    • toBuilder

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

    • builder

      public static EncryptionConfigurationDetails.Builder builder()

    • serializableBuilderClass

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