メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::KMS::Alias

AWS::KMS::Alias リソースは、AWS Key Management Service (AWS KMS) でカスタマーマスターキー (CMK) の表示名を作成します。エイリアスを使用してキーを参照すると、キー管理を簡素化するのに役立ちます。たとえば、キーをローテーションする場合、キー ID を追跡して変更する代わりに、エイリアスのマッピングを更新するだけで済みます。詳細については、AWS Key Management Service Developer Guide の「エイリアスの操作」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

Copy
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

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりエイリアス名 (alias/myKeyAlias など) が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、myKey AWS KMS キーに alias/myKeyAlias エイリアスを作成します。

JSON

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

YAML

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

このページの内容: