Class ConfigurationDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ConfigurationDetails.Builder,
ConfigurationDetails>
The encryption configuration details that include the status information of the Amazon Web Services Key Management Service (KMS) key and the KMS access role.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ConfigurationDetails.Builder
builder()
final ConfigurationStatus
The health status of KMS key and KMS access role.final String
The health status of KMS key and KMS access role.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The error code that indicates either the KMS key or the KMS access role isUNHEALTHY
.final String
The detailed error message that corresponds to theerrorCode
.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends ConfigurationDetails.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
-
configurationStatus
The health status of KMS key and KMS access role. If either KMS key or KMS access role is
UNHEALTHY
, the return value will beUNHEALTHY
. To use a customer-managed KMS key, the value ofconfigurationStatus
must beHEALTHY
.If the service returns an enum value that is not available in the current SDK version,
configurationStatus
will returnConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconfigurationStatusAsString()
.- Returns:
- The health status of KMS key and KMS access role. If either KMS key or KMS access role is
UNHEALTHY
, the return value will beUNHEALTHY
. To use a customer-managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - See Also:
-
configurationStatusAsString
The health status of KMS key and KMS access role. If either KMS key or KMS access role is
UNHEALTHY
, the return value will beUNHEALTHY
. To use a customer-managed KMS key, the value ofconfigurationStatus
must beHEALTHY
.If the service returns an enum value that is not available in the current SDK version,
configurationStatus
will returnConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconfigurationStatusAsString()
.- Returns:
- The health status of KMS key and KMS access role. If either KMS key or KMS access role is
UNHEALTHY
, the return value will beUNHEALTHY
. To use a customer-managed KMS key, the value ofconfigurationStatus
must beHEALTHY
. - See Also:
-
errorCode
The error code that indicates either the KMS key or the KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
.- Returns:
- The error code that indicates either the KMS key or the KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
.
-
errorMessage
The detailed error message that corresponds to the
errorCode
.- Returns:
- The detailed error message that corresponds to the
errorCode
.
-
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<ConfigurationDetails.Builder,
ConfigurationDetails> - 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.
-