Class: Aws::KMS::Types::UpdateKeyDescriptionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::UpdateKeyDescriptionRequest
- 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
-
#description ⇒ String
New description for the CMK.
-
#key_id ⇒ String
A unique identifier for the customer master key (CMK).
Instance Attribute Details
#description ⇒ String
New description for the CMK.
2446 2447 2448 2449 2450 |
# File 'lib/aws-sdk-kms/types.rb', line 2446 class UpdateKeyDescriptionRequest < Struct.new( :key_id, :description) include Aws::Structure end |
#key_id ⇒ String
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.
2446 2447 2448 2449 2450 |
# File 'lib/aws-sdk-kms/types.rb', line 2446 class UpdateKeyDescriptionRequest < Struct.new( :key_id, :description) include Aws::Structure end |