Class: Aws::KMS::Types::XksKeyConfigurationType

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::XksKeyConfigurationType

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

Information about the [external key ][1]that is associated with a KMS key in an external key store.

This element appears in a CreateKey or DescribeKey response only for a KMS key in an external key store.

The *external key* is a symmetric encryption key that is hosted by an external key manager outside of Amazon Web Services. When you use the KMS key in an external key store in a cryptographic operation, the cryptographic operation is performed in the external key manager using the specified external key. For more information, see [External key] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #id ⇒ String

  The ID of the external key in its external key manager.

Instance Attribute Details

#id ⇒ String

The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 6719

class XksKeyConfigurationType < Struct.new(
  :id)
  SENSITIVE = []
  include Aws::Structure
end