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

AWS::CloudFormation::Interface

AWS::CloudFormation::Interface は、AWS CloudFormation コンソールでパラメーターをグループ化およびソートする方法を定義するメタデータキーです。コンソールでスタックを作成または更新すると、コンソールに入力パラメーターが論理 ID のアルファベット順にリストされます。ユーザーがパラメーター値を効率的に指定できるように、このキーを使用して、パラメーターのグループ化とソートを独自に定義することができます。たとえば、すべての EC2 関連パラメーターを 1 つのグループに含め、すべての VPC 関連パラメーターを別のグループに含めることができます。

パラメーターのグループ化とソートに加え、パラメーターのラベルを定義できます。ラベルは、パラメーターの論理 ID の代わりにコンソールに表示されるフレンドリ名または説明です。ラベルは、各パラメーターに指定する値をユーザーが理解するのに役立ちます。たとえば、KeyPair パラメーターには Select an EC2 key pair というラベルを付けることができます。

注記

AWS::CloudFormation::Interface メタデータキーは、AWS CloudFormation コンソールでのみ使用されます。AWS CloudFormation CLI と API 呼び出しでは、このキーが使用されません。

トピック

構文

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

JSON

Copy
"Metadata" : { "AWS::CloudFormation::Interface" : { "ParameterGroups" : [ ParameterGroup, ... ], "ParameterLabels" : ParameterLabel } }

YAML

Copy
Metadata: AWS::CloudFormation::Interface: ParameterGroups: - ParameterGroup ParameterLabels: ParameterLabel

プロパティ

ParameterGroups

パラメーターグループタイプ、グループ名を指定する場所、各グループ内のパラメーター、パラメーターが表示される順序のリスト。

Required: No

タイプ: AWS CloudFormation Interface ParameterGroup

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

ParameterLabels

スタックが作成または更新されたときに AWS CloudFormation コンソールに表示されるパラメーターとそのフレンドリ名のマッピング。

Required: No

タイプ: AWS CloudFormation インターフェイス ParameterLabel

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

次の例では、2 つのパラメーターグループ Network Configuration および Amazon EC2 Configuration を定義します。Network Configuration グループには、VPCIDSubnetIdSecurityGroupID の各パラメーターが含まれます。これらは、テンプレートの Parameters セクション (非表示) で定義されます。コンソールにこれらのパラメーターが表示される順序は、パラメーターがリストされる順序によって定義されます (先頭は VPCID パラメーター)。この例では、Amazon EC2 Configuration パラメーターも同様にグループ化およびソートされています。

この例では、VPCID パラメーターのラベルも定義しています。コンソールには、[Which VPC should this be deployed to?] という内容がパラメーターの論理 ID (VPCID) の代わりに表示されます。

JSON

Copy
"Metadata" : { "AWS::CloudFormation::Interface" : { "ParameterGroups" : [ { "Label" : { "default" : "Network Configuration" }, "Parameters" : [ "VPCID", "SubnetId", "SecurityGroupID" ] }, { "Label" : { "default":"Amazon EC2 Configuration" }, "Parameters" : [ "InstanceType", "KeyName" ] } ], "ParameterLabels" : { "VPCID" : { "default" : "Which VPC should this be deployed to?" } } } }

YAML

Copy
Metadata: AWS::CloudFormation::Interface: ParameterGroups: - Label: default: "Network Configuration" Parameters: - VPCID - SubnetId - SecurityGroupID - Label: default: "Amazon EC2 Configuration" Parameters: - InstanceType - KeyName ParameterLabels: VPCID: default: "Which VPC should this be deployed to?"

コンソールに表示されたパラメーターグループ

次の図は、この例のメタデータキーを使用すると、スタックが作成または更新されたときにパラメータグループがコンソールにどのように表示されるかを示しています。コンソールのパラメータグループ

 コンソールにこの例のパラメータグループが表示されます。

このページの内容: