ALIYUN::NLB::ServerGroup リソースタイプリファレンス - ROS

ALIYUN::NLB::ServerGroupは、ネットワークロードバランサー（NLB）インスタンスのサーバーグループを作成するために使用されます。

構文

{
  "Type": "ALIYUN::NLB::ServerGroup",
  "Properties": {
    "ResourceGroupId": String,
    "Scheduler": String,
    "AddressIPVersion": String,
    "Servers": List,
    "PreserveClientIpEnabled": Boolean,
    "ServerGroupType": String,
    "PersistenceEnabled": Boolean,
    "ConnectionDrainEnabled": Boolean,
    "ConnectionDrainTimeout": Integer,
    "PersistenceTimeout": Integer,
    "VpcId": String,
    "HealthCheckConfig": Map,
    "Protocol": String,
    "ServerGroupName": String,
    "Tags": List,
    "AnyPortEnabled": Boolean
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceGroupId	String	いいえ	いいえ	リソースグループのID。	なし。
Scheduler	String	いいえ	いいえ	スケジューリングアルゴリズム。	有効な値： Wrr（デフォルト）：重み付けラウンドロビン（WRR）。重みの高いバックエンドサーバーは、重みの低いバックエンドサーバーよりも多くのリクエストを受け取ります。 rr：ラウンドロビン（RR）。リクエストはバックエンドサーバーに順番に転送されます。 sch：送信元IPアドレスハッシュ。同じ送信元IPアドレスからのリクエストは、同じバックエンドサーバーに転送されます。 tch：4つの要素に基づく整合性ハッシュ。次の要素に基づいて同じ情報を含むリクエストは、同じバックエンドサーバーに転送されます：送信元IPアドレス、宛先IPアドレス、送信元ポート、および宛先ポート。 qch：Quick UDP Internet Connection（QUIC）IDハッシュ。同じQUIC IDを含むリクエストは、同じバックエンドサーバーに転送されます。
AddressIPVersion	String	いいえ	いいえ	IPバージョン。	有効な値： ipv4（デフォルト）：IPv4 DualStack：デュアルスタック
Servers	List	いいえ	いいえ	サーバー。	詳細については、Serversプロパティをご参照ください。
PreserveClientIpEnabled	Boolean	いいえ	いいえ	クライアントIP保存を有効にするかどうかを指定します。	有効な値： true false（デフォルト）
ServerGroupType	String	いいえ	いいえ	サーバーグループのタイプ。	有効な値： Instance（デフォルト）：Elastic Compute Service（ECS）インスタンス、Edge Node Service（ENS）インスタンス、およびエラスティックコンテナインスタンスをバックエンドサーバーとして追加できます。 Ip：IPアドレスを指定してサーバーを追加できます。
PersistenceEnabled	Boolean	いいえ	いいえ	セッション永続化を有効にするかどうかを指定します。	有効な値： true false
ConnectionDrainEnabled	Boolean	いいえ	いいえ	接続ドレインを有効にするかどうかを指定します。	有効な値： true false（デフォルト）
ConnectionDrainTimeout	Integer	いいえ	いいえ	接続ドレインのタイムアウト期間。	単位：秒。有効な値： 10 ～ 900 。
PersistenceTimeout	Integer	いいえ	いいえ	セッション永続化のタイムアウト期間。	単位：秒。有効な値： 0 ～ 3600 。
VpcId	String	はい	いいえ	サーバーグループが属する仮想プライベートクラウド（VPC）のID。	説明 ServerGroupTypeをInstanceに設定した場合、サーバーとサーバーグループが同じVPCにある場合にのみ、サーバーをサーバーグループに追加できます。
HealthCheckConfig	Map	いいえ	いいえ	ヘルスチェック機能の構成。	詳細については、HealthCheckConfigプロパティをご参照ください。
Protocol	String	いいえ	いいえ	バックエンドプロトコル。	有効な値： TCP（デフォルト） UDP TCPSSL
ServerGroupName	String	はい	いいえ	サーバーグループの名前。	名前は 2 ～ 128 文字で、文字、数字、ピリオド（.）、アンダースコア（_）、およびハイフン（-）を含めることができます。文字で始める必要があります。
AnyPortEnabled	Boolean	いいえ	いいえ	マルチポート転送を有効にするかどうかを指定します。	有効な値： true false
Tags	List	いいえ	はい	タグ。	詳細については、Tagsプロパティをご参照ください。

Servers構文

"Servers": [
  {
    "ServerType": String,
    "Description": String,
    "ServerId": String,
    "ServerIp": String,
    "Port": Integer,
    "Weight": Integer
  }
]

Serversプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ServerType	String	はい	いいえ	バックエンドサーバーのタイプ。	有効な値： Ecs（デフォルト）：ECSインスタンス Eni：エラスティックネットワークインターフェース（ENI） Eci：エラスティックコンテナインスタンス Ip：IPアドレス
Description	String	いいえ	いいえ	バックエンドサーバーの説明。	なし。
ServerId	String	はい	いいえ	バックエンドサーバーとして使用するインスタンスのID。	有効な値： ECSインスタンスのID ENIのID エラスティックコンテナインスタンスのID 説明 ServerIdがENIまたはエラスティックコンテナインスタンスのIDに設定されている場合は、ServerTypeを指定する必要があります。
ServerIp	String	いいえ	いいえ	ECSインスタンス、ENI、またはエラスティックコンテナインスタンスのIPアドレス。	なし。
Port	Integer	いいえ	いいえ	リクエストの受信に使用するポート。	なし。
Weight	Integer	いいえ	いいえ	バックエンドサーバーの重み。	有効な値： 0 ～ 100 。デフォルト値： 100 。

HealthCheckConfig構文

"HealthCheckConfig": {
  "HealthCheckInterval": Integer,
  "HealthCheckUrl": String,
  "HealthCheckConnectPort": Integer,
  "UnhealthyThreshold": Integer,
  "HttpCheckMethod": String,
  "HealthyThreshold": Integer,
  "HealthCheckConnectTimeout": Integer,
  "HealthCheckDomain": String,
  "HealthCheckEnabled": Boolean,
  "HealthCheckHttpCode": List,
  "HealthCheckType": String
}

HealthCheckConfigプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
HealthCheckInterval	Integer	いいえ	いいえ	2つの連続したヘルスチェックの間隔。	単位：秒。有効な値： 5 ～ 50 。デフォルト値： 10 。
HealthCheckUrl	String	いいえ	いいえ	システムがヘルスチェックを実行するパス。	パスは 1 ～ 80 文字で、文字、数字、 - / . % ? # & = 特殊文字、および _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + 拡張文字のみを含めることができます。スラッシュ（/）で始める必要があります。説明このプロパティは、HealthCheckTypeがHttpに設定されている場合に有効になります。
HealthCheckConnectPort	Integer	いいえ	いいえ	ヘルスチェックに使用するバックエンドポート。	有効な値： 0 ～ 65535 。デフォルト値： 0 。値 0 は、バックエンドサーバーのポートがヘルスチェックに使用されることを示します。
UnhealthyThreshold	Integer	いいえ	いいえ	正常なバックエンドサーバーが異常と宣言される前に、ヘルスチェックに連続して失敗する必要がある回数。	有効な値： 2 ～ 10 。デフォルト値： 2 。
HttpCheckMethod	String	いいえ	いいえ	ヘルスチェックに使用するメソッド。	有効な値： GET（デフォルト） HEAD 説明このプロパティは、HealthCheckTypeがHttpに設定されている場合に有効になります。
HealthyThreshold	Integer	いいえ	いいえ	異常なバックエンドサーバーが正常と宣言される前に、ヘルスチェックに連続して合格する必要がある回数。	有効な値： 2 ～ 10 。デフォルト値： 2 。
HealthCheckConnectTimeout	Integer	いいえ	いいえ	ヘルスチェック応答の最大タイムアウト期間。	単位：秒。有効な値： 1 ～ 300 。デフォルト値： 5 。
HealthCheckDomain	String	いいえ	いいえ	ヘルスチェックに使用するドメイン名。	有効な値： $SERVER_IP：バックエンドサーバーのプライベートIPアドレス。 domain：指定するドメイン名。ドメイン名は 1 ～ 80 文字で、小文字、数字、ハイフン（-）、およびピリオド（.）のみを含めることができます。説明このプロパティは、HealthCheckTypeがHttpに設定されている場合に有効になります。
HealthCheckEnabled	Boolean	いいえ	いいえ	ヘルスチェック機能を有効にするかどうかを指定します。	有効な値： true（デフォルト） false
HealthCheckHttpCode	List	いいえ	いいえ	システムがヘルスチェックのために返すHTTPステータスコード。	複数のHTTPステータスコードはコンマ（,）で区切ります。有効な値： http_2xx（デフォルト） http_3xx http_4xx http_5xx 説明このプロパティは、HealthCheckTypeがHttpに設定されている場合に有効になります。
HealthCheckType	String	いいえ	いいえ	ヘルスチェックに使用するプロトコル。	有効な値： Tcp（デフォルト） Http

Tags構文

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tagsプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	なし。
Value	String	いいえ	いいえ	タグ値。	なし。

戻り値

Fn::GetAtt

ServerGroupId：サーバーグループのID。

例

次のセクションでは、指定されたIPアドレスに関連付けられたサーバーグループを作成する方法の例を示します。

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: ''
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
Resources:
  NlbServerGroup:
    Type: ALIYUN::NLB::ServerGroup
    Properties:
      Servers:
        - ServerId: 10.1.1.102
          ServerIp: 10.1.1.102
          Port: 80
          Weight: 100
          ServerType: Ip
      ServerGroupType: Ip
      ServerGroupName: Test
      VpcId:
        Ref: VpcId
      HealthCheckConfig:
        HttpCheckMethod: Get
        HealthCheckEnabled: true
        HealthCheckConnectTimeout: Null
      Protocol: TCP
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    }
  },
  "Resources": {
    "NlbServerGroup": {
      "Type": "ALIYUN::NLB::ServerGroup",
      "Properties": {
        "Servers": [
          {
            "ServerId": "10.1.1.102",
            "ServerIp": "10.1.1.102",
            "Port": 80,
            "Weight": 100,
            "ServerType": "Ip"
          }
        ],
        "ServerGroupType": "Ip",
        "ServerGroupName": "Test",
        "VpcId": {
          "Ref": "VpcId"
        },
        "HealthCheckConfig": {
          "HttpCheckMethod": "Get",
          "HealthCheckEnabled": true,
          "HealthCheckConnectTimeout": null
        },
        "Protocol": "TCP"
      }
    }
  },
  "Outputs": {
  }
}