kms_update_alias: Associates an existing KMS alias with a different KMS key

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

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.

See https://www.paws-r-sdk.com/docs/kms_update_alias/ for full documentation.

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.

paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.