aws-cdk-lib.aws_kms.AliasAttributes

interface AliasAttributes

LanguageType name
.NETAmazon.CDK.AWS.KMS.AliasAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskms#AliasAttributes
Javasoftware.amazon.awscdk.services.kms.AliasAttributes
Pythonaws_cdk.aws_kms.AliasAttributes
TypeScript (source)aws-cdk-lib » aws_kms » AliasAttributes

Properties of a reference to an existing KMS Alias.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kms as kms } from 'aws-cdk-lib';

declare const key: kms.Key;
const aliasAttributes: kms.AliasAttributes = {
  aliasName: 'aliasName',
  aliasTargetKey: key,
};

Properties

NameTypeDescription
aliasNamestringSpecifies the alias name.
aliasTargetKeyIKeyThe customer master key (CMK) to which the Alias refers.

aliasName

Type: string

Specifies the alias name.

This value must begin with alias/ followed by a name (i.e. alias/ExampleAlias)


aliasTargetKey

Type: IKey

The customer master key (CMK) to which the Alias refers.