すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:テンプレート構造

最終更新日:Jan 16, 2025

テンプレートは、UTF-8 エンコードされた JSON または YAML ファイルです。テンプレートはスタックの作成に使用され、基盤となるインフラストラクチャとアーキテクチャの設計図として機能します。Resource Orchestration Service (ROS) テンプレートでは、Alibaba Cloud リソース、構成、およびリソースの関連付けを定義できます。

ROS テンプレート構造

ROSTemplateFormatVersion: '2015-09-01'
Description: The description of the template.  // テンプレートの説明。説明セクションには、テンプレートのシナリオやアーキテクチャなどの情報が記載されています。
Metadata: 
  # The metadata of the template. The Metadata section provides information such as layouts for visualizations. // テンプレートのメタデータ。メタデータセクションには、視覚化のためのレイアウトなどの情報が記載されています。
  Parameters: 
  # The custom parameters that you can specify in the template when you create a stack.  // スタックの作成時にテンプレートで指定できるカスタムパラメータ。
  Mappings: 
  # The mapping tables of the template. Mapping tables are nested tables. // テンプレートのマッピングテーブル。マッピングテーブルはネストされたテーブルです。
  Conditions: 
  # The conditions of the template, which are defined by using intrinsic condition functions. The conditions determine when the system can create associated resources. // テンプレートの条件。これは組み込みの条件関数を使用して定義されます。条件によって、システムが関連リソースを作成できるタイミングが決まります。
  Resources: 
  # The resources of the template. The Resources section contains the detailed information about resources, such as the associations and configurations of resources. // テンプレートのリソース。リソースセクションには、リソースの関連付けや構成など、リソースに関する詳細情報が含まれています。
  Outputs: 
  # The outputs of the template. The Outputs section declares the outputs that you want to obtain, such as resource properties. You can obtain outputs by using the ROS console or by calling specific ROS API operations. // テンプレートの出力。出力セクションでは、取得したい出力 (リソースのプロパティなど) を宣言します。出力は、ROS コンソールを使用するか、特定の ROS API オペレーションを呼び出すことによって取得できます。
  Rules: 
  # The rules of the template. When you create or update a stack, the Rules section validates whether the parameter values that are passed to the template are valid. // テンプレートのルール。スタックを作成または更新するときに、ルールセクションは、テンプレートに渡されるパラメータ値が有効かどうかを検証します。

(必須) ROSTemplateFormatVersion

ROS テンプレートのフォーマットバージョン。値を 2015-09-01 に設定します。

(オプション) Description

テンプレートの説明。テンプレートのシナリオやアーキテクチャなどの情報を提供します。テンプレートの内容をよりよく理解するために、詳細な説明を指定することをお勧めします。

(オプション) Metadata

テンプレートのメタデータ。メタデータは JSON 形式にすることができます。

(オプション) Parameters

スタックの作成時にテンプレートで指定できるカスタムパラメータ。ほとんどの場合、Elastic Compute Service (ECS) インスタンスタイプはパラメータとして定義されます。パラメータにはデフォルト値があります。パラメータを使用すると、テンプレートの柔軟性と再利用性を向上させることができます。 Parameters セクションを含むテンプレートに基づいてスタックを作成する場合、適切なインスタンスタイプを選択できます。

詳細については、「パラメータ」をご参照ください。

(オプション) Mappings

マッピングは、ネストされたマッピングテーブルとして定義されます。Fn::FindInMap 関数を呼び出して、指定されたキーに基づいて名前付きの値を返すことができます。また、パラメータをキーとして入力して、マッピングテーブル内のマッピングを検索することもできます。たとえば、リージョンをキーとして使用して、リージョンとリージョンイメージマッピングテーブル内の適切なイメージを照合できます。

詳細については、「マッピング」をご参照ください。

(オプション) Conditions

テンプレートの条件。Fn::And、Fn::Or、Fn::Not、Fn::Equals の各関数を使用して条件を定義できます。複数の条件はコンマ (,) で区切ります。ROS は、スタックを作成または更新する前に、テンプレート内のすべての条件を評価します。true 条件に関連付けられているすべてのリソースが作成され、false 条件に関連付けられているすべてのリソースは無視されます。

詳細については、「条件」をご参照ください。

(オプション) Resources

テンプレートに基づいて作成されるスタック内のリソースに関する詳細情報。情報には、リソースの関連付けと構成が含まれます。

詳細については、「リソース」をご参照ください。

(オプション) Outputs

テンプレートの出力。Outputs セクションでは、取得したい出力 (リソースのプロパティなど) を宣言します。出力は、ROS コンソールを使用するか、特定の ROS API オペレーションを呼び出すことによって取得できます。

詳細については、「出力」をご参照ください。

(オプション) Rules

テンプレートのルール。スタックを作成または更新するときに、Rules セクションは、テンプレートに渡されるパラメータ値が有効かどうかを検証します。

詳細については、「ルール」をご参照ください。

次の手順

テンプレートのベストプラクティスをよく理解しておいてください。詳細については、「テンプレートのデプロイ」をご参照ください。