CloudFormation テンプレートの Metadata セクション構文リファレンス
オプションの Metadata
セクションを使用して、テンプレートの詳細を提供する任意の JSON または YAML オブジェクトを含めることができます。たとえば、次のコードスニペットに示すように、特定のリソースについてのテンプレートの実装の詳細を含めることができます。
重要
スタックの更新時に、Metadata
セクションを単独で更新することはできません。更新できるのは、リソースを追加、変更、または削除する変更を含める場合だけです。
重要
CloudFormation は、Metadata
セクションに含める情報の変換、変更、または編集を行いません。このため、パスワードやシークレットなどの機密情報を保存しないことを強くお勧めします。
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"
メタデータキー
一部の CloudFormation 機能は、Metadata
セクションで定義した設定または設定情報を取得します。この情報は、次の CloudFormation 固有のメタデータキーで定義します。
AWS::CloudFormation::Init
-
cfn-init ヘルパースクリプトの構成タスクを定義します。このスクリプトは、EC2 インスタンスでアプリケーションの設定とインストールを行う場合に便利です。詳細については、「AWS::CloudFormation::Init」を参照してください。
AWS::CloudFormation::Interface
-
CloudFormation コンソールに表示される場合の入力パラメータのグループ化と順序を定義します。デフォルトでは、CloudFormation コンソールではパラメータが論理 ID によりアルファベット順にソートされます。詳細については、「AWS::CloudFormation::Interface」を参照してください。
AWS::CloudFormation::Designer
-
AWS CloudFormation デザイナー (デザイナー) でリソースがどのように配置されているかを説明します。この情報を使用してテンプレートを作成および更新すると、デザイナーによりこの情報が自動的に追加されます。詳細については、「以前のバージョンの AWS CloudFormation デザイナーを使用してテンプレートを作成する」を参照してください。