interface ConfigurationDetailsProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnEncryptionConfiguration.ConfigurationDetailsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnEncryptionConfiguration_ConfigurationDetailsProperty
Java	software.amazon.awscdk.services.iot.CfnEncryptionConfiguration.ConfigurationDetailsProperty
Python	aws_cdk.aws_iot.CfnEncryptionConfiguration.ConfigurationDetailsProperty
TypeScript	aws-cdk-lib » aws_iot » CfnEncryptionConfiguration » ConfigurationDetailsProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const configurationDetailsProperty: iot.CfnEncryptionConfiguration.ConfigurationDetailsProperty = {
  configurationStatus: 'configurationStatus',
  errorCode: 'errorCode',
  errorMessage: 'errorMessage',
};

Properties

Name	Type	Description
configurationStatus?	string	The health status of KMS key and AWS access role.
errorCode?	string	The error code that indicates either the KMS key or the AWS access role is UNHEALTHY .
errorMessage?	string	The detailed error message that corresponds to the errorCode .

---

configurationStatus?

Type: string (optional)

The health status of KMS key and AWS access role.

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

---

errorCode?

Type: string (optional)

The error code that indicates either the KMS key or the AWS 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

---

errorMessage?

Type: string (optional)

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