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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/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

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)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_idString

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

Returns:

  • (String)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_dateTime

The date and time when the CMK was created.

Returns:

  • (Time)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_dateTime

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.

Returns:

  • (Time)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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

#descriptionString

The description of the CMK.

Returns:

  • (String)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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

#enabledBoolean

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

Returns:

  • (Boolean)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_modelString

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

Returns:

  • (String)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_idString

The globally unique identifier for the CMK.

Returns:

  • (String)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_managerString

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.

Returns:

  • (String)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_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)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_usageString

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.

Returns:

  • (String)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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

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

Returns:

  • (String)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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_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)


1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1422

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