Class: Aws::KMS::Types::KeyMetadata
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::KeyMetadata
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations.
Instance Attribute Summary collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the CMK.
-
#aws_account_id ⇒ String
The twelve-digit account ID of the AWS account that owns the CMK.
-
#creation_date ⇒ Time
The date and time when the CMK was created.
-
#deletion_date ⇒ Time
The date and time after which AWS KMS deletes the CMK.
-
#description ⇒ String
The description of the CMK.
-
#enabled ⇒ Boolean
Specifies whether the CMK is enabled.
-
#expiration_model ⇒ String
Specifies whether the CMK’s key material expires.
-
#key_id ⇒ String
The globally unique identifier for the CMK.
-
#key_manager ⇒ String
The CMK’s manager.
-
#key_state ⇒ String
The state of the CMK.
-
#key_usage ⇒ String
The cryptographic operations for which you can use the CMK.
-
#origin ⇒ String
The source of the CMK’s key material.
-
#valid_to ⇒ Time
The time at which the imported key material expires.
Instance Attribute Details
#arn ⇒ String
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*.
[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#aws_account_id ⇒ String
The twelve-digit account ID of the AWS account that owns the CMK.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#creation_date ⇒ Time
The date and time when the CMK was created.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#deletion_date ⇒ Time
The date and time after which AWS KMS deletes the CMK. This value is present only when ‘KeyState` is `PendingDeletion`, otherwise this value is omitted.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#description ⇒ String
The description of the CMK.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#enabled ⇒ Boolean
Specifies whether the CMK is enabled. When ‘KeyState` is `Enabled` this value is true, otherwise it is false.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#expiration_model ⇒ String
Specifies whether the CMK’s key material expires. This value is present only when ‘Origin` is `EXTERNAL`, otherwise this value is omitted.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#key_id ⇒ String
The globally unique identifier for the CMK.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#key_manager ⇒ String
The CMK’s manager. CMKs 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*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#key_state ⇒ String
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*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#key_usage ⇒ String
The cryptographic operations for which you can use the CMK. Currently the only allowed value is ‘ENCRYPT_DECRYPT`, which means you can use the CMK for the Encrypt and Decrypt operations.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#origin ⇒ String
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.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |
#valid_to ⇒ Time
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.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'lib/aws-sdk-kms/types.rb', line 1512 class KeyMetadata < Struct.new( :aws_account_id, :key_id, :arn, :creation_date, :enabled, :description, :key_usage, :key_state, :deletion_date, :valid_to, :origin, :expiration_model, :key_manager) include Aws::Structure end |