Package software.amazon.awscdk.services.iot

Interface CfnEncryptionConfiguration.ConfigurationDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEncryptionConfiguration.ConfigurationDetailsProperty.Jsii$Proxy

Enclosing class:

CfnEncryptionConfiguration

@Stability(Stable)
public static interface CfnEncryptionConfiguration.ConfigurationDetailsProperty
extends software.amazon.jsii.JsiiSerializable

The encryption configuration details that include the status information of the AWS Key Management Service ( AWS KMS ) key and the AWS KMS access role.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 ConfigurationDetailsProperty configurationDetailsProperty = ConfigurationDetailsProperty.builder()
         .configurationStatus("configurationStatus")
         .errorCode("errorCode")
         .errorMessage("errorMessage")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEncryptionConfiguration.ConfigurationDetailsProperty.Builder	A builder for CfnEncryptionConfiguration.ConfigurationDetailsProperty
static final class	CfnEncryptionConfiguration.ConfigurationDetailsProperty.Jsii$Proxy	An implementation for CfnEncryptionConfiguration.ConfigurationDetailsProperty

Method Summary

Modifier and Type	Method	Description
static CfnEncryptionConfiguration.ConfigurationDetailsProperty.Builder	builder()
default String	getConfigurationStatus()	The health status of KMS key and AWS KMS access role.
default String	getErrorCode()	The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY .
default String	getErrorMessage()	The detailed error message that corresponds to the errorCode .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationStatus

@Stability(Stable)
@Nullable
default String getConfigurationStatus()

The health status of KMS key and AWS KMS access role.

If either KMS key or AWS 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-configurationstatus

getErrorCode

@Stability(Stable)
@Nullable
default String getErrorCode()

The error code that indicates either the KMS key or the AWS KMS access role is UNHEALTHY .

Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-errorcode

getErrorMessage

@Stability(Stable)
@Nullable
default String getErrorMessage()

The detailed error message that corresponds to the errorCode .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-encryptionconfiguration-configurationdetails.html#cfn-iot-encryptionconfiguration-configurationdetails-errormessage

builder

@Stability(Stable)
static CfnEncryptionConfiguration.ConfigurationDetailsProperty.Builder builder()

Returns:

a CfnEncryptionConfiguration.ConfigurationDetailsProperty.Builder of CfnEncryptionConfiguration.ConfigurationDetailsProperty