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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2617
2618
2619
2620
2621
2622
2623
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2617

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) 


2617
2618
2619
2620
2621
2622
2623
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2617

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) 


2617
2618
2619
2620
2621
2622
2623
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2617

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