paws.security.identity (version 0.1.12)

kms_create_alias: Creates a friendly name for a customer master key (CMK)

Description

Creates a friendly name for a customer master key (CMK). You can use an alias to identify a CMK in the AWS KMS console, in the describe_key operation and in cryptographic operations, such as encrypt and generate_data_key.

You can also change the CMK that's associated with the alias (update_alias) or delete the alias (delete_alias) at any time. These operations don't affect the underlying CMK.

You can associate the alias with any customer managed CMK in the same AWS Region. Each alias is associated with only on CMK at a time, but a CMK can have multiple aliases. A valid CMK is required. You can't create an alias without a CMK.

The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see Using aliases in the AWS Key Management Service Developer Guide.

This operation does not return a response. To get the alias that you created, use the list_aliases operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

Required permissions

• kms:CreateAlias on the alias (IAM policy).

• kms:CreateAlias on the CMK (key policy).

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

Related operations:

• delete_alias

• list_aliases

• update_alias

Usage

kms_create_alias(AliasName, TargetKeyId)

Value

An empty list.

Arguments

AliasName

[required] Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

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 AWS managed CMKs.

TargetKeyId

[required] Associates the alias with the specified customer managed CMK. The CMK must be in the same AWS Region.

A valid CMK 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 AWS Key Management Service Developer Guide.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use list_keys or describe_key.

Request syntax

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

Examples

if (FALSE) {
# The following example creates an alias for the specified customer master
# key (CMK).
svc$create_alias(
  AliasName = "alias/ExampleAlias",
  TargetKeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)
}