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

Resource Orchestration Service:パラメーター

最終更新日:Aug 22, 2026

テンプレートの Parameters セクションでは、スタック作成時にユーザーが指定する入力値を定義することで、テンプレートの柔軟性と再利用性を高めます。

構文

各パラメーターには名前と一連のプロパティがあります。パラメーター名には英字と数字のみ使用でき、テンプレート内で一意である必要があります。ラベル プロパティを使用してエイリアスを定義します。

次の表では、サポートされているプロパティについて説明します。

プロパティ

必須

説明

Type

はい

パラメーターのデータ型。有効な値は次のとおりです:

  • String:文字列。例:"ecs.s1.medium"

  • Number:整数または浮動小数点数。例:3.14。

  • CommaDelimitedList:カンマ区切りの値のリスト。インデックスで値を取得するには、Fn::Select を使用します。例:"80, foo, bar"

  • Json:JSON 文字列。例:{"foo": "bar"} または [1, 2, 3]

  • Boolean:ブール値。例:true または false

  • ALIYUN::OOS::Parameter::Value:CloudOps Orchestration Service (OOS) のパラメーター ストアに格納されている共通パラメーター。詳細については、「共通パラメーター」をご参照ください。例:my_image

  • ALIYUN::OOS::SecretParameter::Value:OOS パラメーター ストアに格納されている暗号化パラメーター (暗号化パラメーター)。例:my_password

説明

AllowedPattern は、ALIYUN::OOS::Parameter::Value 型と ALIYUN::OOS::SecretParameter::Value 型をサポートしていません。

Default

いいえ

パラメーターのデフォルト値。スタック作成時に値が指定されていない場合、ROS はこのデフォルト値を使用します。デフォルト値が定義されていない場合は、エラーが返されます。

説明

デフォルトが Null に設定されている場合、パラメーターは空として扱われ、検証はスキップされます。

AllowedValues

いいえ

パラメーターの有効な値。

AllowedPattern

いいえ

String 型パラメーターを検証するための正規表現。String 型以外のパラメーターにこのプロパティを適用すると、エラーが発生します。

次の特殊文字の前に、バックスラッシュを 2 つ (\\) 付加します:

*.?+-$^[ ]( ){ }|\/
説明

範囲の最初または最後の文字として使用されるハイフン (-) は、エスケープする必要はありません。例:[a-z-]

MaxLength

いいえ

String 型パラメーターに許可される最大文字数。

MinLength

いいえ

String 型パラメーターに必要な最小文字数。

MaxValue

いいえ

Number 型パラメーターに許可される最大数値。

MinValue

いいえ

Number 型パラメーターに許可される最小数値。

NoEcho

いいえ

true に設定すると、ROS はスタック作成時およびスタック詳細ビューで、パラメーター値をアスタリスク (*) でマスクします。

Confirm

いいえ

NoEchotrue に設定されている場合、パラメーター値を 2 回入力する必要があります。デフォルト値:false

説明

Confirm プロパティは、NoEcho プロパティが true である String 型パラメーターに対してのみ true に設定できます。

Description

パラメーターの説明。ローカライズされた値をサポートします:

  • zh-cn:中国語の説明。

  • en:英語の説明。

説明

コンソールには、現在の言語設定に一致する説明が表示されます。

制約の説明

いいえ

パラメーターの制約に違反した場合に表示されるエラーメッセージ。

Label

いいえ

パラメーターの UTF-8 エンコードされたエイリアス。テンプレートベースの Web フォームでは、ラベルの値がパラメーター名にマッピングされます。

AssociationProperty

いいえ

パラメーター値を自動的に検証し、有効なオプションのリストを提供します。

ROS がサポートする AssociationProperty の値と例については、「AssociationProperty and AssociationPropertyMetadata」をご参照ください。

AssociationPropertyMetadata

いいえ

AssociationProperty を制約し、一致した項目をフィルタリングするマップ。

このプロパティは Map 型です。AssociationPropertyAssociationPropertyMetadata の対応関係と例については、「AssociationProperty and AssociationPropertyMetadata」をご参照ください。

TextArea

いいえ

パラメーターが改行をサポートするかどうかを指定します。有効な値は次のとおりです:

  • true

  • false (デフォルト)

次の例では、Content パラメーターは改行をサポートします:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Content:
    Type: String
    TextArea: true
Outputs:
  TestContent:
    Value:
      Ref: Content

Required

いいえ

パラメーターが必須かどうかを指定します。有効な値は次のとおりです:

  • true:パラメーターは必須です。

  • false:パラメーターはオプションです。

次の例では、ECSInstanceId パラメーターは必須です。

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CreateNewECS:
    Type: Boolean
    Label: Whether to Create New Instance
    Default: false
  ECSInstanceId:
    Type: String
    Required: true  # Required: true は、パラメーターが必須であることを指定します (コンソール表示にのみ影響します)。
    Default: Null
    AssociationPropertyMetadata:
      Visible:
        Condition:
          Fn::Equals:
            - ${CreateNewECS}
            - false
説明

Required プロパティはフロントエンドの表示にのみ影響し、バックエンドでの検証を強制するものではありません。

Placeholder

いいえ

パラメーターの入力フィールドに表示されるヒント。

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  MyParameter:
    Type: String
    Placeholder:
      en: 'Enter a value for the parameter.'

例:InstanceType パラメーターの定義

1 つの SLB インスタンス、2 つの ECS インスタンス、および 1 つの ApsaraDB RDS インスタンスを含む Web アプリケーション用のスタックを作成する場合を考えます。ワークロード要件に基づいて、異なる ECS インスタンスタイプを選択できます。次のコードは、テンプレートで InstanceType パラメーターを定義します:

Parameters:
  InstanceType:
    Type: String
    AllowedValues:
      - ecs.t1.small
      - ecs.s1.medium
      - ecs.m1.medium
      - ecs.c1.large
    Default: ecs.t1.small
    Label: ECS インスタンスタイプ
    Description: インスタンスタイプを選択します。デフォルト値:ecs.t1.small。有効な値:ecs.t1.small、ecs.s1.medium、ecs.m1.medium、および ecs.c1.large。

この定義により、スタックを作成するたびに異なる InstanceType 値を選択できます。InstanceType パラメーターを省略した場合、デフォルトの ecs.t1.small が使用されます。

次のコードは、リソース定義で InstanceType パラメーターを参照します:

Webserver:
  Type: ALIYUN::ECS::Instance
  InstanceType:
    Ref: InstanceType