kms_create_alias: Creates a friendly name for a KMS key

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

Creates a friendly name for a KMS key

Description

Creates a friendly name for a KMS key.

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

Usage

kms_create_alias(AliasName, TargetKeyId)

Arguments

AliasName

[required] Specifies the alias name. This value must begin with ⁠alias/⁠ followed by a name, such as alias/ExampleAlias. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ⁠alias/aws/⁠. The ⁠alias/aws/⁠ prefix is reserved for Amazon Web Services managed keys.

TargetKeyId

[required] Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide . 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.

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