Class: Aws::KMS::Types::UpdateKeyDescriptionRequest

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

Overview

Note:

When making an API call, you may pass UpdateKeyDescriptionRequest data as a hash:

{
  key_id: "KeyIdType", # required
  description: "DescriptionType", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

New description for the CMK.

Returns:

  • (String)


2891
2892
2893
2894
2895
# File 'lib/aws-sdk-kms/types.rb', line 2891

class UpdateKeyDescriptionRequest < Struct.new(
  :key_id,
  :description)
  include Aws::Structure
end

#key_idString

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`

  • Key ARN: ‘arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Returns:

  • (String)


2891
2892
2893
2894
2895
# File 'lib/aws-sdk-kms/types.rb', line 2891

class UpdateKeyDescriptionRequest < Struct.new(
  :key_id,
  :description)
  include Aws::Structure
end