AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::KMS::Alias

AWS::KMS::Alias 资源在 AWS Key Management Service (AWS KMS) 中为客户主密钥 (CMK) 创建显示名称。使用别名引用密钥有助于您简化密钥管理。例如,在轮换密钥时,您可以只更新别名映射,而不用跟踪和更改密钥 ID。有关更多信息,请参阅 AWS Key Management Service Developer Guide 中的使用别名

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

YAML

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

属性

AliasName

别名的名称。名称必须以 alias 开头,后面跟有正斜杠,例如 alias/。您不能指定以 alias/AWS 开头的别名。这些别名是预留的别名。

Required: Yes

Type: String

更新要求替换

TargetKeyId

您为其创建别名的密钥的 ID。指定密钥的全局唯一标识符或 Amazon 资源名称 (ARN)。您不能指定另一个别名。

Required: Yes

Type: String

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回别名,例如 alias/myKeyAlias

有关使用 Ref 功能的更多信息,请参阅参考

示例

下面的示例为 myKey AWS KMS 密钥创建 alias/myKeyAlias 别名。

JSON

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

YAML

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

本页内容: