This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::IoT::EncryptionConfiguration ConfigurationDetails
The encryption configuration details that include the status information of the AWS Key Management Service (AWS KMS) key and the AWS KMS access role.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ConfigurationStatus" :
String
, "ErrorCode" :String
, "ErrorMessage" :String
}
YAML
ConfigurationStatus:
String
ErrorCode:String
ErrorMessage:String
Properties
ConfigurationStatus
-
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 beUNHEALTHY
. To use a customer managed KMS key, the value ofconfigurationStatus
must beHEALTHY
.Required: No
Type: String
Allowed values:
HEALTHY | UNHEALTHY
Update requires: No interruption
ErrorCode
-
The error code that indicates either the KMS key or the AWS KMS access role is
UNHEALTHY
. Valid values:KMS_KEY_VALIDATION_ERROR
andROLE_VALIDATION_ERROR
.Required: No
Type: String
Update requires: No interruption
ErrorMessage
-
The detailed error message that corresponds to the
errorCode
.Required: No
Type: String
Update requires: No interruption