概覽

參數屬性

必須

描述

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：儲存在OOS參數倉庫中的普通參數。更多資訊，請參見普通參數。例如：my_image。

• ALIYUN::OOS::SecretParameter::Value：儲存在OOS參數倉庫中的加密參數。更多資訊，請參見加密參數。例如：my_password。

Default

否

在建立資源棧時，如果使用者沒有傳入模板中給出的指定值，ROS會檢查模板中是否定義預設值。如果已定義預設值，則使用預設值，否則報錯。

AllowedValues

否

包含參數允許取值的列表。

AllowedPattern

否

Regex，用於檢查使用者輸入的字串類型的參數是否匹配該Regex。如果使用者輸入的不是字串類型，則報錯。

如果使用以下特殊字元，需要在字元前輸入兩個反斜線（\\）進行轉義：

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

MaxLength

否

一個整數值，輸入的String型別參數值的最大長度。

MinLength

否

一個整數值，輸入的String型別參數值的最小長度。

MaxValue

否

一個數字值，允許Number類型使用的最大數字值。

MinValue

否

一個數字值，允許Number類型使用的最小數字值。

NoEcho

否

如果將值設定為true，則只輸出星號（*）。您可以在建立資源棧或查看資源棧時，查看是否輸出參數值。

Confirm

否

當NoEcho取值為true時，參數是否需要二次輸入確認。預設值為false。

Description

描述參數的字串。取值：

• zh-cn：使用中文對參數進行描述。

• en：使用英文對參數進行描述。

ConstraintDescription

否

違反參數的約束條件時，說明對應參數約束條件的字串。

Label

否

參數別名，支援UTF-8字元。通過模板產生Web表單時，可映射為label。

AssociationProperty

否

是Parameters的一個特性組件，用於自動驗證參數值的合法性，並且給參數提供可選值。

ROS支援的AssociationProperty及其樣本，請參見AssociationProperty和AssociationPropertyMetadata。

AssociationPropertyMetadata

否

為AssociationProperty定義約束條件，篩選出合格結果。

該屬性屬於Map類型。AssociationProperty對應的AssociationPropertyMetadata及其樣本，請參見AssociationProperty和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: 是否建立新的執行個體
    Default: false
  ECSInstanceId:
    Type: String
    Required: true  # 通過Required控制參數是否必填（前端效果）
    Default: Null
    AssociationPropertyMetadata:
      Visible:
        Condition:
          Fn::Equals:
            - ${CreateNewECS}
            - false

Placeholder

否

支援參數輸入框自訂提示。

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Placeholder:
    Type: String
    Placeholder:
      en: Placeholder
      zh-cn: 中文 Placeholder