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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

Contains metadata about a KMS key.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the KMS key. For examples, see

Key Management Service (KMS)][1

in the Example ARNs section of the

*Amazon Web Services General Reference*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_hsm_cluster_idString

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateTime

The date and time when the KMS key was created.

Returns:

  • (Time)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#custom_key_store_idString

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#customer_master_key_specString

Instead, use the `KeySpec` field.

The `KeySpec` and `CustomerMasterKeySpec` fields have the same value. We recommend that you use the `KeySpec` field in your code. However, to avoid breaking changes, KMS will support both fields.

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_dateTime

The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its `KeyState` is `PendingDeletion`.

When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is `PendingReplicaDeletion` and the length of its waiting period is displayed in the `PendingDeletionWindowInDays` field.

Returns:

  • (Time)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the KMS key.

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#enabledBoolean

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

Returns:

  • (Boolean)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_algorithmsArray<String>

The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

This value is present only when the `KeyUsage` of the KMS key is `ENCRYPT_DECRYPT`.

Returns:

  • (Array<String>)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#expiration_modelString

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

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#key_idString

The globally unique identifier for the KMS key.

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#key_managerString

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see [KMS keys] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#key_specString

Describes the type of key material in the KMS key.

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#key_stateString

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see [Key states of KMS keys] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#key_usageString

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#mac_algorithmsArray<String>

The message authentication code (MAC) algorithm that the HMAC KMS key supports.

This value is present only when the `KeyUsage` of the KMS key is `GENERATE_VERIFY_MAC`.

Returns:

  • (Array<String>)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#multi_regionBoolean

Indicates whether the KMS key is a multi-Region (`True`) or regional (`False`) key. This value is `True` for multi-Region primary and replica keys and `False` for regional KMS keys.

For more information about multi-Region keys, see [Multi-Region keys in KMS] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html

Returns:

  • (Boolean)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_configurationTypes::MultiRegionConfiguration

Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the `MultiRegion` field is `True`.

For more information about any listed KMS key, use the DescribeKey operation.

  • `MultiRegionKeyType` indicates whether the KMS key is a `PRIMARY` or `REPLICA` key.

  • `PrimaryKey` displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

  • `ReplicaKeys` displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#originString

The source of the key material for the KMS key. When this value is `AWS_KMS`, KMS created the key material. When this value is `EXTERNAL`, the key material was imported or the KMS key doesn't have any key material. When this value is `AWS_CLOUDHSM`, the key material was created in the CloudHSM cluster associated with a custom key store.

Returns:

  • (String)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#pending_deletion_window_in_daysInteger

The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the `KeyState` of the KMS key is `PendingReplicaDeletion`. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the `DeletionDate` field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the `KeyState` of the scheduled primary key changes from `PendingReplicaDeletion` to `PendingDeletion` and the deletion date appears in the `DeletionDate` field.

Returns:

  • (Integer)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#signing_algorithmsArray<String>

The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

This field appears only when the `KeyUsage` of the KMS key is `SIGN_VERIFY`.

Returns:

  • (Array<String>)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#valid_toTime

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

Returns:

  • (Time)

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
# File 'lib/aws-sdk-kms/types.rb', line 3607

class KeyMetadata < Struct.new(
  :aws_account_id,
  :key_id,
  :arn,
  :creation_date,
  :enabled,
  :description,
  :key_usage,
  :key_state,
  :deletion_date,
  :valid_to,
  :origin,
  :custom_key_store_id,
  :cloud_hsm_cluster_id,
  :expiration_model,
  :key_manager,
  :customer_master_key_spec,
  :key_spec,
  :encryption_algorithms,
  :signing_algorithms,
  :multi_region,
  :multi_region_configuration,
  :pending_deletion_window_in_days,
  :mac_algorithms)
  SENSITIVE = []
  include Aws::Structure
end