Class ConfigurationDetails

java.lang.Object
software.amazon.awssdk.services.iot.model.ConfigurationDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ConfigurationDetails.Builder,ConfigurationDetails>
@Generated("software.amazon.awssdk:codegen") public final class ConfigurationDetails extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • configurationStatus

      public final ConfigurationStatus 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 be UNHEALTHY. To use a customer-managed KMS key, the value of configurationStatus must be HEALTHY.

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

      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 be UNHEALTHY. To use a customer-managed KMS key, the value of configurationStatus must be HEALTHY.
      See Also:

    • configurationStatusAsString

      public final String 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 be UNHEALTHY. To use a customer-managed KMS key, the value of configurationStatus must be HEALTHY.

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

      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 be UNHEALTHY. To use a customer-managed KMS key, the value of configurationStatus must be HEALTHY.
      See Also:

    • errorCode

      public final String errorCode()

      The error code that indicates either the KMS key or the KMS access role is UNHEALTHY. Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_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 and ROLE_VALIDATION_ERROR.

    • errorMessage

      public final String errorMessage()

      The detailed error message that corresponds to the errorCode.

      Returns:
      The detailed error message that corresponds to the errorCode.

    • toBuilder

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

    • builder

      public static ConfigurationDetails.Builder builder()

    • serializableBuilderClass

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