Class EncryptionConfigurationDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final KmsKeyStatus
The current status of encryption configuration.final String
The current status of encryption configuration.final String
Provides additional context about the current encryption status.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final KmsKeyType
keyType()
The type of KMS key used for encryption.final String
The type of KMS key used for encryption.final String
The ARN of the KMS key currently used to encrypt data in your IAM Identity Center instance.static Class
<? extends EncryptionConfigurationDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnKmsKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- Returns:
- The type of KMS key used for encryption.
- See Also:
-
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 returnKmsKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- Returns:
- The type of KMS key used for encryption.
- See Also:
-
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
The current status of encryption configuration.
If the service returns an enum value that is not available in the current SDK version,
encryptionStatus
will returnKmsKeyStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionStatusAsString()
.- Returns:
- The current status of encryption configuration.
- See Also:
-
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 returnKmsKeyStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionStatusAsString()
.- Returns:
- The current status of encryption configuration.
- See Also:
-
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
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 interfaceToCopyableBuilder<EncryptionConfigurationDetails.Builder,
EncryptionConfigurationDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-