Resource Orchestration Service:基本リソース

AssociationProperty 値

説明

対応する AssociationPropertyMetadata

Auto

ROS は、元の Terraform データ構造に基づいて、AssociationProperty や AssociationPropertyMetadata などのフィールドを自動的に生成します。

上書き：内部ネストされたパラメーターの定義を補足または上書きします。

このオプションパラメーターは、以下のコンポーネントを含むディクショナリです。

• キー

  内部ネストされたパラメーターへのパスです。パスルールは以下のとおりです。

  • リストまたはセット内の要素を表すには、* を使用します。

  • オブジェクト内のアイテムを表すには、アイテム名を使用します。

  • パスを区切るには、ドット (.) を使用します。

  • パスの先頭と途中にある * 文字は省略できます。パスの末尾にある 1 つ以上の * 文字は省略できません。

  例：

  // The path for name is name.
  // The path for address is address.
  variable "user_information" {
    type = object({
      name    = string
      address = string
    })
  }
  
  // The path for elements in region_ids is *.
  variable "region_ids" {
    type    = list(string)
  }
  
  // The path for internal is *.internal, which can be abbreviated as internal.
  // The path for external is *.external, which can be abbreviated as external.
  // The path for protocol is *.protocol, which can be abbreviated as protocol.
  variable "docker_ports" {
    type = list(object({
      internal = number
      external = number
      protocol = string
    }))
  }
  
  // The path for b is *.b, which can be abbreviated as b.
  // The path for elements in b is *.b.*, which can be abbreviated as b.*
  // The path for c is *.c, which can be abbreviated as c.
  // The path for d is *.c.*.d, which can be abbreviated as c.d.
  // The path for elements in d is *.c.*.d.*, which can be abbreviated as c.d.*
  // The path for e is *.e, which can be abbreviated as e.
  // The path for elements in e is *.e.*, which can be abbreviated as e.*.
  // The path for elements in e is *.e.*.*, which can be abbreviated as e.*.* (you must keep both * characters).
  // The path for f is *.f, which can be abbreviated as f.
  // The path for g is *.f.*.*.g, which can be abbreviated as f.g.
  // The path for elements in g is *.f.*.*.g.*, which can be abbreviated as f.g.*
  variable "complex_type_demo" {
    type = list(object({
      b = list(string)
      c = list(object({
        d = list(string)
      }))
      e = list(list(string))
      f = list(list(object({
        g = list(string)
      })))
    }))
  }

• 値

  パラメーター定義の補足です。詳細については、「概要」をご参照ください。

AutoCompleteInput

ランダム文字列を自動的に生成します。

• CharacterClasses

  • クラス：文字タイプです。有効な値：

    • 小文字

    • 大文字

    • 数値

    • specialCharacter

  • 最小：現在のタイプにおける最小文字数です。

  • SpecialCharacters：指定された特殊文字です。このパラメーターは、クラスが specialCharacter に設定されている場合にのみ有効です。

  • 開始：文字列が特殊文字で始まることができるかどうかを指定します。このパラメーターは、クラスが specialCharacter に設定されている場合にのみ有効です。

  • 終了：文字列が特殊文字で終わることができるかどうかを指定します。このパラメーターは、クラスが specialCharacter に設定されている場合にのみ有効です。

• プレフィックス：文字列のプレフィックスです。

• サフィックス：文字列のサフィックスです。

• 長さ：文字列の長さです。

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ManagedKubernetesClusterName": {
      "Type": "String",
      "Label": {
        "en": "Managed Kubernetes Cluster Name",
        "zh-cn": "ACK managed cluster name"
      },
      "AssociationProperty": "AutoCompleteInput",
      "AssociationPropertyMetadata": {
        "Length": 5,
        "Prefix": "cluster-for-mse-",
        "Suffix": "-by-ros",
        "CharacterClasses": [
          {
            "Class": "lowercase",
            "min": 1
          }
        ]
      }
    }
  }
}

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ManagedKubernetesClusterName:
    Type: String
    Label:
      en: Managed Kubernetes Cluster Name
      zh-cn: ACK managed cluster name
    AssociationProperty: AutoCompleteInput
    AssociationPropertyMetadata:
      Length: 5
      Prefix: cluster-for-mse-
      Suffix: '-by-ros'
      CharacterClasses:
        - Class: lowercase
          min: 1

ChargeType

課金方法です。有効な値：

• 従量課金

• サブスクリプション

なし

Code

コード入力フィールドです。

なし

CommaDelimitedList

コンマ区切りの配列です。

なし

Cron

cron 式です。これは、定期タスクの実行時間を指定するフォーマットされた文字列です。

なし

DateTime

日付です。

• GMTZone：GMT ゾーンです。

• TimeZone：タイムゾーンの説明です。

FileContent

ローカルファイルからコンテンツを読み取ります。

AcceptFileSuffixes：アップロードで許可されるファイルタイプです。複数のファイルタイプはコンマで区切ります。

GMTZone

GMT ゾーン選択です。

例：

• コード例

  JSON 例：

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "GMTZone": {
        "Type": "String",
        "AssociationProperty": "GMTZone"
      }
    }
  }

  YAML 例：

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    GMTZone:
      Type: String
      AssociationProperty: GMTZone

• 説明例

  この例では、GMTZone パラメーターの AssociationProperty に GMTZone を指定することで、GMT ゾーンが設定されます。

Json

JSON オブジェクト入力です。

なし

List[Parameter]

パラメーターのリストです。インデントを使用してパラメーターを配置します。

これは、JSON パラメーターにのみ適用されます。

• パラメーター：パラメーター定義です。

• モード：表示スタイルです。

  • 折りたたみ：折りたたみスタイルです。これがデフォルト値です。

  • テーブル：テーブルスタイルです。

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

例：

• コード例

  JSON 例：

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "RegionIds": {
        "Label": {
          "en": "ECS Region Ids",
          "zh-cn": "ECS Region List"
        },
        "MaxLength": 100,
        "MinLength": 1,
        "Type": "Json",
        "AssociationProperty": "List[Parameter]",
        "AssociationPropertyMetadata": {
          "Parameter": {
            "Type": "String",
            "AssociationProperty": "ALIYUN::ECS::RegionId",
            "MinLength": 1,
            "MaxLength": 64
          }
        }
      }
    }
  }

  YAML 例：

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    RegionIds:
      Label:
        en: ECS Region Ids
        zh-cn: ECS Region List
      MaxLength: 100
      MinLength: 1
      Type: Json
      AssociationProperty: List[Parameter]
      AssociationPropertyMetadata:
        Parameter:
          Type: String
          AssociationProperty: ALIYUN::ECS::RegionId
          MinLength: 1
          MaxLength: 64

• 説明例

  この例では、AssociationProperty に List[Parameter] を、AssociationPropertyMetadata に Parameter を指定することで、複数の ECS リージョン ID をコンソールでインデントして配置します。

List[Parameters]

パラメーターグループのリストです。テーブルを使用してパラメーターグループを配置します。

これは、JSON パラメーターにのみ適用されます。

• パラメーター：パラメーター定義のグループを表す必須ディクショナリです。

  • キー：パラメーター名です。

  • 値：パラメーター定義です。詳細については、「概要」をご参照ください。

    説明

    テーブルが配置に使用されるため、単純なパラメーターを使用してください。ネストは推奨されません。

  例：

  • コード例

    JSON 例：

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RenameECS": {
          "Label": {
            "en": "Rename ECS",
            "zh-cn": "Rename ECS"
          },
          "MaxLength": 100,
          "MinLength": 1,
          "Type": "Json",
          "AssociationProperty": "List[Parameters]",
          "AssociationPropertyMetadata": {
            "Parameters": {
              "InstanceId": {
                "Type": "String",
                "Label": {
                  "en": "ECS Instance Id",
                  "zh-cn": "ECS Instance ID"
                },
                "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
                "MinLength": 1,
                "MaxLength": 64
              },
              "Name": {
                "Type": "String",
                "Label": {
                  "en": "New Name",
                  "zh-cn": "New Name"
                },
                "MinLength": 1
              }
            }
          }
        }
      }
    }

    YAML 例：

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RenameECS:
        Label: Rename ECS
        MaxLength: 100
        MinLength: 1
        Type: Json
        AssociationProperty: List[Parameters]
        AssociationPropertyMetadata:
          Parameters:
            InstanceId:
              Type: String
              Label: ECS instance ID
              AssociationProperty: ALIYUN::ECS::Instance::InstanceId
              MinLength: 1
              MaxLength: 64
            Name:
              Type: String
              Label: New name
              MinLength: 1

  • 説明例

    この例では、AssociationProperty に List[Parameters] を、AssociationPropertyMetadata に Parameters を指定することで、複数の ECS インスタンス ID をコンソールでテーブルに配置します。

• ListMetadata：テーブル表示を制御するために使用されるディクショナリです。

  • ShowHeader：テーブルヘッダーを表示するかどうかを示す列挙型です。デフォルト値は true です。

  • ShowRemove：削除ボタンを表示するかどうかを示す列挙型です。デフォルト値は true です。

  • ShowAddition：追加ボタンを表示するかどうかを示す列挙型です。デフォルト値は true です。

  • Order：テーブル内で左から右へ各列に対応するパラメーターを示す文字列のリストです。デフォルトでは、すべてのパラメーターがアルファベット順で表示されます。

OOSServiceRole

OOS サーバロールです。

RegionId：リージョン ID です。デフォルト値はスタックのリージョンです。

Password

パスワード入力フィールドです。

なし

RateControl

OOS 実行レートです。

例：

• コード例

  JSON 例：

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "RateControl": {
        "Type": "String",
        "AssociationProperty": "RateControl"
      }
    }
  }

  YAML 例：

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    RateControl:
      Type: String
      AssociationProperty: RateControl

• 説明例

  この例では、RateControl パラメーターの AssociationProperty に RateControl を指定することで、OOS 実行レートが設定されます。

Tags

タグです。

• RegionId：リージョン ID です。デフォルト値はスタックのリージョンです。

• ResourceType：グループ統計のリソースタイプです。デフォルト値は ALIYUN::ECS::INSTANCE です。

Targets

ECS インスタンスオブジェクトです。インスタンス ID、タグ、リソースグループ、またはその他の方法でインスタンスを選択できます。

RegionId：リージョン ID です。デフォルト値はスタックのリージョンです。

TextArea

リッチテキスト入力フィールドです。

なし

TimeTriggerWeekly

週単位で時間を選択します。

例：

• コード例

  JSON 例：

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "TimeTriggerWeekly": {
        "Type": "String",
        "AssociationProperty": "TimeTriggerWeekly"
      }
    }
  }

  YAML 例：

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    TimeTriggerWeekly:
      Type: String
      AssociationProperty: TimeTriggerWeekly

• 説明例

  この例では、TimeTriggerWeekly パラメーターの AssociationProperty に TimeTriggerWeekly を指定することで、週単位で時間が選択されます。

TimeZone

タイムゾーン選択です。

例：

• コード例

  JSON 例：

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "TimeZone": {
        "Type": "String",
        "AssociationProperty": "TimeZone"
      }
    }
  }

  YAML 例：

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    TimeZone:
      Type: String
      AssociationProperty: TimeZone

• 説明例

  この例では、TimeZone パラメーターの AssociationProperty に TimeZone を指定することで、タイムゾーンが設定されます。

なし

インデントを使用してパラメーターを配置します。

これは、JSON パラメーターにのみ適用されます。

• パラメーター：パラメーター定義のグループを表すディクショナリです。

  • キー：パラメーター名です。

  • 値：パラメーター定義です。詳細については、「概要」をご参照ください。

  例：

  • コード例

    JSON 例：

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RenameECS": {
          "Label": {
            "en": "Rename ECS",
            "zh-cn": "Rename ECS"
          },
          "MaxLength": 100,
          "MinLength": 1,
          "Type": "Json",
          "AssociationPropertyMetadata": {
            "Parameters": {
              "InstanceId": {
                "Type": "String",
                "Label": {
                  "en": "ECS Instance Id",
                  "zh-cn": "ECS Instance ID"
                },
                "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
                "MinLength": 1,
                "MaxLength": 64
              },
              "Name": {
                "Type": "String",
                "Label": {
                  "en": "New Name",
                  "zh-cn": "New Name"
                },
                "MinLength": 1
              }
            }
          }
        }
      }
    }

    YAML 例：

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RenameECS:
        Label:
          en: Rename ECS
          zh-cn: Rename ECS
        MaxLength: 100
        MinLength: 1
        Type: Json
        AssociationPropertyMetadata:
          Parameters:
            InstanceId:
              Type: String
              Label:
                en: ECS Instance Id
                zh-cn: ECS Instance ID
              AssociationProperty: ALIYUN::ECS::Instance::InstanceId
              MinLength: 1
              MaxLength: 64
            Name:
              Type: String
              Label:
                en: New Name
                zh-cn: New Name
              MinLength: 1

  • 説明例

    この例では、AssociationProperty は指定されていません。AssociationPropertyMetadata が Parameters としてのみ指定され、単一の ECS インスタンス ID をコンソールでインデントして配置します。

• Metadata：ディクショナリです。詳細については、「Metadata」をご参照ください。