Class: Aws::KMS::Types::UpdateAliasRequest

Inherits:

Struct

Object
Struct
Aws::KMS::Types::UpdateAliasRequest

show all

Includes:: Structure

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

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#alias_name ⇒ String

Identifies the alias that is changing its KMS key.
#target_key_id ⇒ String

Identifies the [customer managed key] to associate with the alias.

Instance Attribute Details

#alias_name ⇒ `String`

Identifies the alias that is changing its KMS key. This value must begin with ‘alias/` followed by the alias name, such as `alias/ExampleAlias`. You cannot use `UpdateAlias` to change the alias name.

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

Returns:

(String)

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

class UpdateAliasRequest < Struct.new(
  :alias_name,
  :target_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#target_key_id ⇒ `String`

Identifies the [customer managed key] to associate with the alias. You don’t have permission to associate an alias with an [Amazon Web Services managed key].

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct KMS key, use ListAliases.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk