テンプレートのメタデータセクションの構文 - Resource Orchestration Service

メタデータを使用して、テンプレートの Parameters セクションで定義されているパラメーターをグループ化し、特定のパラメーターを非表示にすることができます。パラメーターの表示効果を確認するには、Resource Orchestration Service (ROS) コンソールの [パラメーターの設定] ステップに移動します。

メタデータの構文

Metadata:
  ALIYUN::ROS::Interface:
    # ParameterGroups は必須です。
    ParameterGroups:
      - <ParameterGroup1>
      - <ParameterGroup2>
      - ...

ParameterGroup の構文

# Parameters は必須です。
Parameters: 
    - <Parameter1>
    - <Parameter2>
    - ...
# Label は必須です。
Label: 
    default: <カスタム文字列>

例: パラメーターのグループ化

テンプレートの Parameters セクションで定義されているパラメーターをグループ化し、各グループにラベルを指定できます。

ROSTemplateFormatVersion: '2015-09-01'
Description: メタデータの例。
Metadata:
  ALIYUN::ROS::Interface:
    ParameterGroups:
      - Parameters:
          - VpcName
          - VpcCidrBlock
        Label:
          default: VPC
      - Parameters:
          - VswName
          - VswCidrBlock
        Label:
          default: VSwitch
Parameters:
  VpcName:
    Type: String
    Label: 名前
    Description: 名前は 2 ～ 128 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。文字で始める必要があります。
    Default: MyVPC
  VswName:
    Type: String
    Label: 名前
    Description: 名前は 2 ～ 128 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。文字で始める必要があります。
    Default: MyVSwitch
  VpcCidrBlock:
    Type: String
    AllowedValues:
      - 10.0.0.0/8
      - 172.16.0.0/12
      - 192.168.0.0/16
    Description: VPC の CIDR ブロック。カスタム CIDR ブロックを指定するには、テンプレートの AllowedValues で指定されている有効な CIDR ブロックを変更する必要があります。カスタム CIDR ブロックは、有効な CIDR ブロックのサブネットである必要があります。
    Label: IPv4 CIDR ブロック
    Default: 192.168.0.0/16
  VswCidrBlock:
    Type: String
    Description: vSwitch の CIDR ブロックは、VPC CIDR ブロックのサブネットである必要があり、他の vSwitch では使用されていない必要があります。
    Label: IPv4 CIDR ブロック
    Default: 192.168.1.0/24
Resources:
  VSwitch:
    Type: ALIYUN::ECS::VSwitch
    Properties:
      VpcId:
        Ref: VPC
      ZoneId:
        Fn::Select:
          - '1'
          - Fn::GetAZs:
              Ref: ALIYUN::Region
      CidrBlock:
        Ref: VswCidrBlock
      VSwitchName:
        Ref: VswName
  VPC:
    Type: ALIYUN::ECS::VPC
    Properties:
      CidrBlock:
        Ref: VpcCidrBlock
      VpcName:
        Ref: VpcName

例: パラメーターの非表示

テンプレートの Hidden で目的のパラメーターを指定して、パラメーター情報が ROS コンソールに表示されないようにすることができます。

ROSTemplateFormatVersion: '2015-09-01'
Description: メタデータの例。
Metadata:
  ALIYUN::ROS::Interface:
    ParameterGroups:
      - Parameters:
          - VpcName
        Label:
          default: VPC
      - Parameters:
          - VswName
        Label:
          default: VSwitch
    # Hidden で指定したパラメーターは、ROS コンソールに表示されません。
    Hidden:
      - VpcCidrBlock
      - VswCidrBlock
Parameters:
  VpcName:
    Type: String
    Label: 名前
    Description: 名前は 2 ～ 128 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。文字で始める必要があります。
    Default: MyVPC
  VswName:
    Type: String
    Label: 名前
    Description: 名前は 2 ～ 128 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。文字で始める必要があります。
    Default: MyVSwitch
  VpcCidrBlock:
    Type: String
    AllowedValues:
      - 10.0.0.0/8
      - 172.16.0.0/12
      - 192.168.0.0/16
    Description: VPC の CIDR ブロック。カスタム CIDR ブロックを指定するには、テンプレートの AllowedValues で指定されている有効な CIDR ブロックを変更する必要があります。カスタム CIDR ブロックは、有効な CIDR ブロックのサブネットである必要があります。
    Label: IPv4 CIDR ブロック
    Default: 192.168.0.0/16
  VswCidrBlock:
    Type: String
    Description: vSwitch の CIDR ブロックは、VPC CIDR ブロックのサブネットである必要があり、他の vSwitch では使用されていない必要があります。
    Label: IPv4 CIDR ブロック
    Default: 192.168.1.0/24
Resources:
  VSwitch:
    Type: ALIYUN::ECS::VSwitch
    Properties:
      VpcId:
        Ref: VPC
      ZoneId:
        Fn::Select:
          - '1'
          - Fn::GetAZs:
              Ref: ALIYUN::Region
      CidrBlock:
        Ref: VswCidrBlock
      VSwitchName:
        Ref: VswName
  VPC:
    Type: ALIYUN::ECS::VPC
    Properties:
      CidrBlock:
        Ref: VpcCidrBlock
      VpcName:
        Ref: VpcName