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 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 { 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 KMS access role.
errorCode?	`string`	The error code that indicates either the KMS key or the AWS KMS 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 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 .

errorCode?

Type: string (optional)

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 .

errorMessage?

Type: string (optional)

The detailed error message that corresponds to the errorCode .