AWS::IoT::EncryptionConfiguration ConfigurationDetails - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::IoT::EncryptionConfiguration ConfigurationDetails

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

Syntax

To declare this entity in your Amazon 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 Amazon KMS access role. If either KMS key or Amazon 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.

Required: No

Type: String

Allowed values: HEALTHY | UNHEALTHY

Update requires: No interruption

ErrorCode

The error code that indicates either the KMS key or the Amazon KMS access role is UNHEALTHY. Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_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