Class: Aws::KMS::Types::TagResourceRequest

Inherits:

Struct

Object
Struct
Aws::KMS::Types::TagResourceRequest

show all

Defined in:: gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#key_id ⇒ String
Identifies a customer managed key in the account and Region.
#tags ⇒ Array<Types::Tag>
One or more tags.

Instance Attribute Details

#key_id ⇒ `String`

Identifies a customer managed key in the account and Region.

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)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5887

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

#tags ⇒ `Array<Types::Tag>`

One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.