You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KMS::Types::KeyMetadata

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains metadata about a customer master key (CMK).

This data type is used as a response element for the CreateKey and DescribeKey operations.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the CMK.

#aws_account_idString

The twelve-digit account ID of the AWS account that owns the CMK.

Returns:

  • (String)

    The twelve-digit account ID of the AWS account that owns the CMK.

#cloud_hsm_cluster_idString

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

Returns:

  • (String)

    The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK.

#creation_dateTime

The date and time when the CMK was created.

Returns:

  • (Time)

    The date and time when the CMK was created.

#custom_key_store_idString

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

Returns:

  • (String)

    A unique identifier for the [custom key store][1] that contains the CMK.

#deletion_dateTime

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Returns:

  • (Time)

    The date and time after which AWS KMS deletes the CMK.

#descriptionString

The description of the CMK.

Returns:

  • (String)

    The description of the CMK.

#enabledBoolean

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

Returns:

  • (Boolean)

    Specifies whether the CMK is enabled.

#expiration_modelString

Specifies whether the CMK\'s key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Possible values:

  • KEY_MATERIAL_EXPIRES
  • KEY_MATERIAL_DOES_NOT_EXPIRE

Returns:

  • (String)

    Specifies whether the CMK\'s key material expires.

#key_idString

The globally unique identifier for the CMK.

Returns:

  • (String)

    The globally unique identifier for the CMK.

#key_managerString

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

Returns:

  • (String)

    The manager of the CMK.

#key_stateString

The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Returns:

  • (String)

    The state of the CMK.

#key_usageString

The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.

Possible values:

  • ENCRYPT_DECRYPT

Returns:

  • (String)

    The cryptographic operations for which you can use the CMK.

#originString

The source of the CMK\'s key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

Possible values:

  • AWS_KMS
  • EXTERNAL
  • AWS_CLOUDHSM

Returns:

  • (String)

    The source of the CMK\'s key material.

#valid_toTime

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Returns:

  • (Time)

    The time at which the imported key material expires.