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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

New description for the KMS key.

Returns:

  • (String)

5395
5396
5397
5398
5399
5400
# File 'lib/aws-sdk-kms/types.rb', line 5395

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

#key_idString

Updates the description of the specified KMS key.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Returns:

  • (String)

5395
5396
5397
5398
5399
5400
# File 'lib/aws-sdk-kms/types.rb', line 5395

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