ALIYUN::ESS::ServerGroupAttachment でサーバグループをスケーリンググループに追加 - ROS

ALIYUN::ESS::ServerGroupAttachment は、1 つ以上のサーバーロードバランサー（SLB）サーバーグループをスケーリンググループに追加するために使用されます。サポートされている SLB サーバーグループには、アプリケーションロードバランサー（ALB）サーバーグループとネットワークロードバランサー（NLB）サーバーグループが含まれます。

構文

{
  "Type": "ALIYUN::ESS::ServerGroupAttachment",
  "Properties": {
    "ServerGroups": List,
    "ScalingGroupId": String,
    "ForceAttach": Boolean
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ServerGroups	List	はい	いいえ	サーバーグループ。	スケーリンググループには最大 100 個のサーバーグループを追加できます。詳細については、「ServerGroups プロパティ」をご参照ください。
ScalingGroupId	String	はい	いいえ	スケーリンググループの ID。	なし。
ForceAttach	Boolean	いいえ	いいえ	現在のスケーリンググループ内のすべての Elastic Compute Service（ECS）インスタンスを、新しく追加されたサーバーグループに追加するかどうかを指定します。	有効値： true false (デフォルト)

ServerGroups 構文

"ServerGroups": [
  {
    "Type": String,
    "Port": Integer,
    "ServerGroupId": String,
    "Weight": Integer
  }
]

ServerGroups プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Type	String	はい	いいえ	サーバーグループのタイプ。	有効値： ALB NLB
Port	Integer	はい	いいえ	サーバーグループに追加された後、ECS インスタンスによって使用されるポート番号。	有効値：0 ～ 65535。
ServerGroupId	String	はい	いいえ	サーバーグループの ID。	なし。
Weight	Integer	はい	いいえ	関連付けられているサーバーグループのバックエンドサーバーとしての ECS インスタンスの重み。	重みが大きいほど、ECS インスタンスに転送されるリクエストの数が多いことを示します。 ECS インスタンスの Weight を 0 に設定すると、アクセスリクエストは ECS インスタンスに転送されません。有効値：0 ～ 100。

戻り値

Fn::GetAtt

ScalingActivityId：サーバーグループを追加し、スケーリンググループ内の ECS インスタンスをサーバーグループに追加するスケーリングアクティビティの ID。

説明

このパラメーターは、ForceAttach プロパティを true に設定した場合にのみ返されます。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ServerGroups:
    AssociationPropertyMetadata:
      Parameter:
        AssociationPropertyMetadata:
          Parameters:
            Type:
              Type: String
              Description:
                ja: |-
                  バックエンドサーバーグループのタイプ。
                  有効値：
                  ALB
                  NLB
              AllowedValues:
                - ALB
                - NLB
            Port:
              Type: Number
              Description:
                ja: |-
                  Auto Scaling が ECS インスタンスをバックエンドサーバーグループに追加した後、スケーリンググループの ECS インスタンスが使用するポート番号。
                  ALB サーバーグループのポート範囲 [1,65535]、NLB サーバーグループのポート範囲 [0,65535]。
              MinValue: 0
              MaxValue: 65535
            ServerGroupId:
              Type: String
              Description:
                ja: バックエンドサーバーグループの ID。
            Weight:
              Type: Number
              Description:
                ja: |-
                  Auto Scaling が ECS インスタンスをバックエンドサーバーグループに追加した後、スケーリンググループの ECS インスタンスのバックエンドサーバーとしての重み。有効値：0 ～ 100。
                  バックエンドサーバーグループの ECS インスタンスの重みを増やすと、ECS インスタンスに転送されるアクセスリクエストの数が増えます。バックエンドサーバーグループの ECS インスタンスの Weight パラメーターを 0 に設定すると、アクセスリクエストは ECS インスタンスに転送されません。
              MinValue: 0
              MaxValue: 100
        Type: Json
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      ja: サーバーグループに関する情報のコレクション。
    MinLength: 1
    MaxLength: 100
    Default:
      - Type: ALB
        Port: 80
        ServerGroupId: sgp-5yc3bd9lfyh*****
        Weight: 100
  ScalingGroupId:
    Type: String
    Description:
      ja: スケーリンググループの ID。
    Default: asg-bp1fo0dbtsbmqa9h****
  ForceAttach:
    Type: Boolean
    Description:
      ja: |-
        スケーリンググループの Elastic Compute Service (ECS) インスタンスを、新しくアタッチされた SLB インスタンスのバックエンドサーバーグループに追加するかどうかを指定します。有効値：
        true
        false
        デフォルト値：false。
    Default: true
Resources:
  ServerGroupAttachment:
    Type: ALIYUN::ESS::ServerGroupAttachment
    Properties:
      ServerGroups:
        Ref: ServerGroups
      ScalingGroupId:
        Ref: ScalingGroupId
      ForceAttach:
        Ref: ForceAttach
Outputs:
  ScalingActivityId:
    Description: |-
      1 つ以上の SLB インスタンスがスケーリンググループにアタッチされ、スケーリンググループの ECS インスタンスが SLB インスタンスのバックエンドサーバーグループに追加されるスケーリングアクティビティの ID。
      注：このパラメーターは、ForceAttach パラメーターを true に設定した後にのみ返されます。
    Value:
      Fn::GetAtt:
        - ServerGroupAttachment
        - ScalingActivityId

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ServerGroups": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "Type": {
                "Type": "String",
                "Description": {
                  "ja": "バックエンドサーバーグループのタイプ。\n有効値：\nALB\nNLB"
                },
                "AllowedValues": [
                  "ALB",
                  "NLB"
                ]
              },
              "Port": {
                "Type": "Number",
                "Description": {
                  "ja": "Auto Scaling が ECS インスタンスをバックエンドサーバーグループに追加した後、スケーリンググループの ECS インスタンスが使用するポート番号。\nALB サーバーグループのポート範囲 [1,65535]、NLB サーバーグループのポート範囲 [0,65535]。"
                },
                "MinValue": 0,
                "MaxValue": 65535
              },
              "ServerGroupId": {
                "Type": "String",
                "Description": {
                  "ja": "バックエンドサーバーグループの ID。"
                }
              },
              "Weight": {
                "Type": "Number",
                "Description": {
                  "ja": "Auto Scaling が ECS インスタンスをバックエンドサーバーグループに追加した後、スケーリンググループの ECS インスタンスのバックエンドサーバーとしての重み。有効値：0 ～ 100。\nバックエンドサーバーグループの ECS インスタンスの重みを増やすと、ECS インスタンスに転送されるアクセスリクエストの数が増えます。バックエンドサーバーグループの ECS インスタンスの Weight パラメーターを 0 に設定すると、アクセスリクエストは ECS インスタンスに転送されません。"
                },
                "MinValue": 0,
                "MaxValue": 100
              }
            }
          },
          "Type": "Json"
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "サーバーグループに関する情報のコレクション。"
      },
      "MinLength": 1,
      "MaxLength": 100,
      "Default": [
        {
          "Type": "ALB",
          "Port": 80,
          "ServerGroupId": "sgp-5yc3bd9lfyh*****",
          "Weight": 100
        }
      ]
    },
    "ScalingGroupId": {
      "Type": "String",
      "Description": {
        "ja": "スケーリンググループの ID。"
      },
      "Default": "asg-bp1fo0dbtsbmqa9h****"
    },
    "ForceAttach": {
      "Type": "Boolean",
      "Description": {
        "ja": "スケーリンググループの Elastic Compute Service (ECS) インスタンスを、新しくアタッチされた SLB インスタンスのバックエンドサーバーグループに追加するかどうかを指定します。有効値：\ntrue\nfalse\nデフォルト値：false。"
      },
      "Default": true
    }
  },
  "Resources": {
    "ServerGroupAttachment": {
      "Type": "ALIYUN::ESS::ServerGroupAttachment",
      "Properties": {
        "ServerGroups": {
          "Ref": "ServerGroups"
        },
        "ScalingGroupId": {
          "Ref": "ScalingGroupId"
        },
        "ForceAttach": {
          "Ref": "ForceAttach"
        }
      }
    }
  },
  "Outputs": {
    "ScalingActivityId": {
      "Description": "1 つ以上の SLB インスタンスがスケーリンググループにアタッチされ、スケーリンググループの ECS インスタンスが SLB インスタンスのバックエンドサーバーグループに追加されるスケーリングアクティビティの ID。\n注：このパラメーターは、ForceAttach パラメーターを true に設定した後にのみ返されます。",
      "Value": {
        "Fn::GetAtt": [
          "ServerGroupAttachment",
          "ScalingActivityId"
        ]
      }
    }
  }
}