Skip to content
v2.274.0

ConfigurationDetailsProperty Struct ​

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

Example ​

ts
// 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 ​

configurationStatusoptionalstringconfiguration_statusoptionalstrconfigurationStatusoptionalStringConfigurationStatusoptionalstringConfigurationStatusoptional*string#
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 .

errorCodeoptionalstringerror_codeoptionalstrerrorCodeoptionalStringErrorCodeoptionalstringErrorCodeoptional*string#
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 .

errorMessageoptionalstringerror_messageoptionalstrerrorMessageoptionalStringErrorMessageoptionalstringErrorMessageoptional*string#
The detailed error message that corresponds to the `errorCode` .