Skip to content

Update Alias

kms_update_alias R Documentation

Associates an existing KMS alias with a different KMS key

Description

Associates an existing KMS alias with a different KMS key. Each alias is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the KMS key must be in the same Amazon Web Services account and Region.

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

The current and new KMS key must be the same type (both symmetric or both asymmetric or both HMAC), and they must have the same key usage. This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of KMS key, use delete_alias to delete the old alias and create_alias to create a new alias.

You cannot use update_alias to change an alias name. To change an alias name, use delete_alias to delete the old alias and create_alias to create a new alias.

Because an alias is not a property of a KMS key, you can create, update, and delete the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the describe_key operation. To get the aliases of all KMS keys in the account, use the list_aliases operation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

Related operations:

  • create_alias

  • delete_alias

  • list_aliases

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Usage

kms_update_alias(AliasName, TargetKeyId)

Arguments

AliasName

[required] 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 update_alias 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.

TargetKeyId

[required] 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 list_keys or describe_key.

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

Value

An empty list.

Request syntax

svc$update_alias(
  AliasName = "string",
  TargetKeyId = "string"
)

Examples

## Not run: 
# The following example updates the specified alias to refer to the
# specified KMS key.
svc$update_alias(
  AliasName = "alias/ExampleAlias",
  TargetKeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

## End(Not run)