1.204.0

interface CfnAliasProps

LanguageType name
.NETAmazon.CDK.AWS.KMS.CfnAliasProps
Javasoftware.amazon.awscdk.services.kms.CfnAliasProps
Pythonaws_cdk.aws_kms.CfnAliasProps
TypeScript @aws-cdk/aws-kms » CfnAliasProps

Properties for defining a CfnAlias.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kms from '@aws-cdk/aws-kms';
const cfnAliasProps: kms.CfnAliasProps = {
  aliasName: 'aliasName',
  targetKeyId: 'targetKeyId',
};

Properties

NameTypeDescription
aliasNamestringSpecifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias .
targetKeyIdstringAssociates the alias with the specified customer managed key . The KMS key must be in the same AWS account and Region.

aliasName

Type: string

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

If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).

The alias 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 keys .

Pattern : ^alias/[a-zA-Z0-9/_-]+$

Minimum : 1

Maximum : 256

targetKeyId

Type: string

Associates the alias with the specified customer managed key . The KMS key must be in the same AWS account and 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 AWS Key Management Service Developer Guide .

Specify the key ID or the 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 .

← PreviousNext →