ALIYUN::KMS::Alias is used to create an alias for a Customer Master Key (CMK).

Syntax

{
  "Type": "ALIYUN::KMS::Alias",
  "Properties": {
    "KeyId": String,
    "AliasName": String
  }
}

Properties

Name Type Required Editable Description Validity
KeyId String Yes No The globally unique identifier of the CMK. None
AliasName String Yes No The alias to give to the CMK. This alias can be used to call the Encrypt, GenerateDataKey, and DescribeKey operations. Excluding the prefix, an alias must be 1 to 255 characters in length. The prefix alias/ must be included.

Response parameters

Fn::GetAtt

  • None

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Alias": {
      "Type": "ALIYUN::KMS::Alias",
      "Properties": {
        "KeyId": {
          "Ref": "KeyId"
        },
        "AliasName": {
          "Ref": "AliasName"
        }
      }
    }
  },
  "Parameters": {
    "KeyId": {
      "Type": "String",
      "Description": "The globally unique identifier of the CMK."
    },
    "AliasName": {
      "MinLength": 1,
      "Type": "String",
      "Description": "- The display name of the key. You can use the alias to call APIs such as Encrypt, GenerateDataKey, and DescribeKey. Excluding the prefix, an alias must be 1 to 255 characters in length. The prefix alias/ must be included.",
      "MaxLength": 255
    }
  },
  "Outputs": {}
}