ALIYUN::ESS::VServerGroupAttachment リソースタイプ - ROS

ALIYUN::ESS::VServerGroupAttachment は、サーバーロードバランサー（SLB）インスタンスの vServer グループをスケーリンググループに関連付けるために使用されます。

構文

{
  "Type": "ALIYUN::ESS::VServerGroupAttachment",
  "Properties": {
    "ScalingGroupId": String,
    "ForceAttach": Boolean,
    "VServerGroups": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ScalingGroupId	String	はい	いいえ	スケーリンググループの ID。	なし。
ForceAttach	Boolean	いいえ	いいえ	スケーリンググループの Elastic Compute Service (ECS) インスタンスを vServer グループに追加するかどうかを指定します。	有効な値: true false (デフォルト)
VServerGroups	List	はい	はい	vServer グループに関する情報。	詳細については、「VServerGroups プロパティ」をご参照ください。

VServerGroups 構文

"VServerGroups": [
  {
    "LoadBalancerId": String,
    "VServerGroupAttributes": List
  }
]

VServerGroups プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
LoadBalancerId	String	はい	いいえ	vServer グループが属する SLB インスタンスの ID。	なし。
VServerGroupAttributes	List	はい	いいえ	vServer グループの属性。	詳細については、「VServerGroupAttributes プロパティ」をご参照ください。

VServerGroupAttributes 構文

"VServerGroupAttributes": [
  {
    "VServerGroupId": String,
    "Port": Integer,
    "Weight": Integer
  }
]

VServerGroupAttributes プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
VServerGroupId	String	はい	いいえ	vServer グループの ID。	なし。
Port	Integer	はい	いいえ	Auto Scaling が ECS インスタンスを vServer グループに追加するために使用するポート番号。	有効な値: 1 ～ 65535。
Weight	Integer	いいえ	いいえ	Auto Scaling によって vServer グループに追加される ECS インスタンスの重み。	有効な値: 0 ～ 100。デフォルト値: 50。

戻り値

Fn::GetAtt

ScalingGroupId: スケーリンググループの ID。

例

YAML フォーマット

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ForceAttach:
    Description:
      ja: 'スケーリンググループのインスタンスをスケーリンググループから vServer グループにアタッチ/デタッチするときに、SLB バックエンドサーバーにアタッチ/デタッチするかどうかを指定します。

        有効な値:

        true

        false

        デフォルト値: false。'
    Required: false
    Type: Boolean
  ScalingGroupId:
    Description:
      ja: スケーリンググループの ID。
    Required: true
    Type: String
  VServerGroups:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        AssociationPropertyMetadata:
          Parameters:
            LoadBalancerId:
              Description:
                ja: VServer グループのロードバランサーサーバー ID。
              Required: true
              Type: String
            VServerGroupAttributes:
              AssociationProperty: List[Parameters]
              AssociationPropertyMetadata:
                Parameters:
                  Port:
                    Description:
                      ja: VServer グループバックエンドサーバーに使用されるポート。
                    MaxValue: 65535
                    MinValue: 0
                    Required: true
                    Type: Number
                  VServerGroupId:
                    Description:
                      ja: VServer グループの ID。
                    Required: true
                    Type: String
                  Weight:
                    Description:
                      ja: 'VServer グループにアタッチされた ECS インスタンスの重み。

                        デフォルト値: 50。'
                    MaxValue: 100
                    MinValue: 0
                    Required: false
                    Type: Number
              Description:
                ja: VServer グループ属性のリスト。
              MaxLength: 5
              MinLength: 1
              Required: true
              Type: Json
        Required: false
        Type: Json
    Description:
      ja: スケーリンググループにアタッチされた vServer グループのリスト
    MaxLength: 5
    MinLength: 1
    Required: true
    Type: Json
Resources:
  VServerGroupAttachment:
    Properties:
      ForceAttach:
        Ref: ForceAttach
      ScalingGroupId:
        Ref: ScalingGroupId
      VServerGroups:
        Ref: VServerGroups
    Type: ALIYUN::ESS::VServerGroupAttachment
Outputs:
  ScalingGroupId:
    Description: スケーリンググループの ID。
    Value:
      Fn::GetAtt:
      - VServerGroupAttachment
      - ScalingGroupId

JSON フォーマット

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ScalingGroupId": {
      "Type": "String",
      "Description": {
        "ja": "スケーリンググループの ID。"
      },
      "Required": true
    },
    "ForceAttach": {
      "Type": "Boolean",
      "Description": {
        "ja": "スケーリンググループのインスタンスをスケーリンググループから vServer グループにアタッチ/デタッチするときに、SLB バックエンドサーバーにアタッチ/デタッチするかどうかを指定します。\n有効な値:\ntrue\nfalse\nデフォルト値: false。"
      },
      "Required": false
    },
    "VServerGroups": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "LoadBalancerId": {
                "Type": "String",
                "Description": {
                  "ja": "VServer グループのロードバランサーサーバー ID。"
                },
                "Required": true
              },
              "VServerGroupAttributes": {
                "AssociationPropertyMetadata": {
                  "Parameters": {
                    "VServerGroupId": {
                      "Type": "String",
                      "Description": {
                        "ja": "VServer グループの ID。"
                      },
                      "Required": true
                    },
                    "Port": {
                      "Type": "Number",
                      "Description": {
                        "ja": "VServer グループバックエンドサーバーに使用されるポート。"
                      },
                      "Required": true,
                      "MinValue": 0,
                      "MaxValue": 65535
                    },
                    "Weight": {
                      "Type": "Number",
                      "Description": {
                        "ja": "VServer グループにアタッチされた ECS インスタンスの重み。\nデフォルト値: 50。"
                      },
                      "Required": false,
                      "MinValue": 0,
                      "MaxValue": 100
                    }
                  }
                },
                "AssociationProperty": "List[Parameters]",
                "Type": "Json",
                "Description": {
                  "ja": "VServer グループ属性のリスト。"
                },
                "Required": true,
                "MinLength": 1,
                "MaxLength": 5
              }
            }
          },
          "Type": "Json",
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "スケーリンググループにアタッチされた vServer グループのリスト"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 5
    }
  },
  "Resources": {
    "VServerGroupAttachment": {
      "Type": "ALIYUN::ESS::VServerGroupAttachment",
      "Properties": {
        "ScalingGroupId": {
          "Ref": "ScalingGroupId"
        },
        "ForceAttach": {
          "Ref": "ForceAttach"
        },
        "VServerGroups": {
          "Ref": "VServerGroups"
        }
      }
    }
  },
  "Outputs": {
    "ScalingGroupId": {
      "Description": "スケーリンググループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "VServerGroupAttachment",
          "ScalingGroupId"
        ]
      }
    }
  }
}