Class: Aws::IoT::Types::ConfigurationDetails

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::ConfigurationDetails

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration_status ⇒ String

  The health status of KMS key and KMS access role.

• #error_code ⇒ String

  The error code that indicates either the KMS key or the KMS access role is ‘UNHEALTHY`.

• #error_message ⇒ String

  The detailed error message that corresponds to the ‘errorCode`.

Instance Attribute Details

#configuration_status ⇒ String

The health status of KMS key and KMS access role. If either KMS key or 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`.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 2480

class ConfigurationDetails < Struct.new(
  :configuration_status,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ String

The error code that indicates either the KMS key or the KMS access role is ‘UNHEALTHY`. Valid values: `KMS_KEY_VALIDATION_ERROR` and `ROLE_VALIDATION_ERROR`.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 2480

class ConfigurationDetails < Struct.new(
  :configuration_status,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

The detailed error message that corresponds to the ‘errorCode`.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 2480

class ConfigurationDetails < Struct.new(
  :configuration_status,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end