CloudFormation テンプレートの Metadata 構文 - AWS CloudFormation
構文

CloudFormation テンプレートの Metadata 構文

Metadata は、JSON オブジェクトまたは YAML オブジェクトを使用して追加情報を保存します。テンプレートで使用できるテンプレートレベルのメタデータのタイプは次のとおりです。

カスタムメタデータ

ユーザー定義のキーと値のペアを保存します。たとえば、リソースの作成には影響しないが、インフラストラクチャ、チーム、またはデプロイの詳細に関する追加のコンテキストを提供する追加情報を提供できます。

AWS::CloudFormation::Interface

CloudFormation コンソールに表示される場合の入力パラメータのグループ化と順序を定義します。デフォルトでは、CloudFormation コンソールではパラメータが論理 ID によりアルファベット順にソートされます。

AWS::CloudFormation::Designer

AWS CloudFormation Designer (Designer) は 2025 年 2 月 5 日にサポートが終了しました。

重要

スタックの更新時に、Metadata セクションを単独で更新することはできません。更新できるのは、リソースを追加、変更、または削除する変更を含める場合だけです。

CloudFormation は、Metadata セクションに含める情報の変換、変更、または編集を行いません。このため、パスワードやシークレットなどの機密情報を保存しないことを強くお勧めします。

構文

CloudFormation テンプレートでカスタムメタデータを宣言するには、次の構文を使用します。

JSON

"Metadata" : {
  "Instances" : {"Description" : "Information about the instances"},
  "Databases" : {"Description" : "Information about the databases"}
}

YAML

Metadata:
  Instances:
    Description: "Information about the instances"
  Databases: 
    Description: "Information about the databases"

AWS::CloudFormation::Interface の構文については、「AWS::CloudFormation::Interface メタデータを使用した CloudFormation パラメータの整理」を参照してください。