AWS::KMS::Alias

The AWS::KMS::Alias resource creates a display name for a customer master key (CMK) in AWS Key Management Service (AWS KMS). Using an alias to refer to a key can help you simplify key management. For example, when rotating keys, you can just update the alias mapping instead of tracking and changing key IDs. For more information, see Working with Aliases in the AWS Key Management Service Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

{
  "Type" : "AWS::KMS::Alias",
  "Properties" : {
    "AliasName" : String,
    "TargetKeyId" : String
  }
}

Type: AWS::KMS::Alias
Properties:
  AliasName: String
  TargetKeyId: String

Properties

Return Value

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the alias name, such as alias/myKeyAlias.

For more information about using the Ref function, see Ref.

Examples

The following examples create the alias/myKeyAlias alias for the myKey AWS KMS key.

"myKeyAlias" : {
  "Type" : "AWS::KMS::Alias",
  "Properties" : {
    "AliasName" : "alias/myKeyAlias",
    "TargetKeyId" : {"Ref":"myKey"}
  }
}

myKeyAlias:
  Type: AWS::KMS::Alias
  Properties:
    AliasName: alias/myKeyAlias
    TargetKeyId:
      Ref: myKey

On this page:

• Syntax
• Properties
• Return Value
• Examples