Package software.amazon.awssdk.services.iot.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigurationDetails.Builder

Method Summary

Modifier and Type	Method	Description
static ConfigurationDetails.Builder	builder()
ConfigurationStatus	configurationStatus()	The health status of KMS key and KMS access role.
String	configurationStatusAsString()	The health status of KMS key and KMS access role.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorCode()	The error code that indicates either the KMS key or the KMS access role is UNHEALTHY.
String	errorMessage()	The detailed error message that corresponds to the errorCode.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ConfigurationDetails.Builder>	serializableBuilderClass()
ConfigurationDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ConfigurationStatus

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:

ConfigurationStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigurationDetails.Builder,ConfigurationDetails>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo