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

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 UpdateAliasRequest data as a hash:

{
  alias_name: "AliasNameType", # required
  target_key_id: "KeyIdType", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias_nameString

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.

Returns:

  • (String)

5294
5295
5296
5297
5298
5299
# File 'lib/aws-sdk-kms/types.rb', line 5294

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

#target_key_idString

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) 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

Returns:

  • (String)

5294
5295
5296
5297
5298
5299
# File 'lib/aws-sdk-kms/types.rb', line 5294

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