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

Class: Aws::SecurityHub::Types::AwsKmsKeyDetails

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

Overview

Note:

When passing AwsKmsKeyDetails as input to an Aws::Client method, you can use a vanilla Hash:

{
  aws_account_id: "NonEmptyString",
  creation_date: 1.0,
  key_id: "NonEmptyString",
  key_manager: "NonEmptyString",
  key_state: "NonEmptyString",
  origin: "NonEmptyString",
  description: "NonEmptyString",
}

Contains metadata about a customer master key (CMK).

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#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.

#creation_dateFloat

Indicates when the CMK was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (Float)

    Indicates when the CMK was created.

#descriptionString

A description of the key.

Returns:

  • (String)

    A description of the key.

#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.

Returns:

  • (String)

    The manager of the CMK.

#key_stateString

The state of the CMK.

Returns:

  • (String)

    The state of 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.

Returns:

  • (String)

    The source of the CMK\'s key material.