ALIYUN::GA::EndpointGroup - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

ALIYUN::GA::EndpointGroup は、エンドポイントグループを作成するために使用されます。

構文

{
  "Type": "ALIYUN::GA::EndpointGroup",
  "Properties": {
    "HealthCheckIntervalSeconds": Integer,
    "EndpointGroupRegion": String,
    "TrafficPercentage": Integer,
    "Description": String,
    "HealthCheckPath": String,
    "HealthCheckProtocol": String,
    "ThresholdCount": Integer,
    "HealthCheckPort": Integer,
    "AcceleratorId": String,
    "EndpointConfigurations": List,
    "Name": String,
    "ListenerId": String
    "HealthCheckEnabled": Boolean,
    "EndpointGroupType": String,
    "EndpointRequestProtocol": String
  }
}

プロパティ

Property	タイプ	必須	編集可能	説明	制約
HealthCheckIntervalSeconds	Integer	No	Yes	ヘルスチェックの実行間隔。	単位：秒。
EndpointGroupRegion	String	Yes	No	エンドポイントグループが配置されているリージョンのID。	なし
TrafficPercentage	Integer	No	Yes	リスナーが複数のエンドポイントグループに関連付けられている場合のエンドポイントグループの重み。	なし
Description	String	No	Yes	エンドポイントグループの説明。	なし
HealthCheckPath	String	No	Yes	ヘルスチェックリクエストの送信先パス。	なし
HealthCheckProtocol	String	No	Yes	ヘルスチェックリクエストの送信に使用するプロトコル。	有効な値： tcp: TCPプロトコル。 http: HTTPプロトコル。 https: HTTPSプロトコル。
ThresholdCount	Integer	No	Yes	エンドポイントが異常と見なされるまでに到達する必要がある、連続したヘルスチェックの失敗回数。	なし
HealthCheckPort	Integer	No	Yes	ヘルスチェックに使用されるポート。	なし
AcceleratorId	String	Yes	No	クエリ対象のGlobal Accelerator（GA）インスタンスのID。	なし
EndpointConfigurations	List	Yes	Yes	エンドポイント。	最大 4 つのエンドポイントを指定できます。詳細については、EndpointConfigurations プロパティをご参照ください。
Name	String	No	Yes	エンドポイントグループの名前。	なし
ListenerId	String	Yes	No	リスナーのID。	なし
HealthCheckEnabled	Boolean	No	Yes	ヘルスチェック機能を有効にするかどうかを指定します。	有効な値： true: はい。これがデフォルト値です。 false: いいえ。
EndpointGroupType	String	No	No	エンドポイントグループのタイプ。	有効な値： default: デフォルトのエンドポイントグループ。これがデフォルト値です。 virtual: 仮想エンドポイントグループ。説明 HTTPリスナーと HTTPS リスナーのみが仮想エンドポイントグループをサポートします。
EndpointRequestProtocol	String	No	Yes	バックエンドサービスで使用されるプロトコル。	有効な値： HTTP: これがデフォルト値です。 HTTPS 説明このプロパティは、エンドポイントグループに関連付けられているリスナーが HTTP または HTTPS プロトコルを使用している場合にのみ設定できます。 HTTPリスナーの場合、バックエンドサービスで使用されるプロトコルは HTTP である必要があります。

EndpointConfigurations 構文

"EndpointConfigurations": [
  {
    "Type": String,
    "Endpoint": String,
    "Weight": Integer,
    "EnableClientIPPreservation": Boolean,
    "EnableProxyProtocol": Boolean
  }
]

EndpointConfigurations プロパティ

Property	タイプ	必須	編集可能	説明	制約
Type	String	Yes	Yes	エンドポイントのタイプ。	有効な値： Domain: カスタムドメイン名。 Ip: カスタム IP アドレス。
Endpoint	String	Yes	Yes	エンドポイントの IP アドレスまたはドメイン名。	なし
Weight	Integer	Yes	Yes	エンドポイントの重み。	なし
EnableClientIPPreservation	Boolean	No	Yes	TCP Option Address（TOA）モジュールを使用してクライアント IP アドレスを保持するかどうかを指定します。	有効な値： true: はい。 false: いいえ。これがデフォルト値です。
EnableProxyProtocol	Boolean	No	Yes	TCP TOA モジュールを使用して、エンドポイントにアクセスするクライアントの IP アドレスを取得して保持するかどうかを指定します。	なし

レスポンスパラメータ

Fn::GetAtt

EndpointGroupId: エンドポイントグループのID。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AcceleratorId:
    Type: String
    Description: エンドポイントグループを関連付ける Global Accelerator インスタンスの ID。 // The ID of the Global Accelerator instance with which the endpoint group will be associated.
  ListenerId:
    Type: String
    Description: エンドポイントグループに関連付けるリスナーの ID。 // The ID of the listener to be associated with the endpoint group.
Resources:
  EndpointGroup:
    Type: ALIYUN::GA::EndpointGroup
    Properties:
      EndpointGroupRegion: cn-beijing
      AcceleratorId:
        Ref: AcceleratorId
      EndpointConfigurations:
        - Type: Ip
          Endpoint: 10.10.10.1
          Weight: 100
      Name: TestEndpointGroup
      ListenerId:
        Ref: ListenerId
Outputs:
  EndpointGroupId:
    Description: エンドポイントグループの ID。 // The ID of the endpoint group.
    Value:
      Fn::GetAtt:
        - EndpointGroup
        - EndpointGroupId

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AcceleratorId": {
      "Type": "String",
      "Description": "エンドポイントグループを関連付ける Global Accelerator インスタンスの ID。" // The ID of the Global Accelerator instance with which the endpoint group will be associated.
    },
    "ListenerId": {
      "Type": "String",
      "Description": "エンドポイントグループに関連付けるリスナーの ID。" // The ID of the listener to be associated with the endpoint group.
    }
  },
  "Resources": {
    "EndpointGroup": {
      "Type": "ALIYUN::GA::EndpointGroup",
      "Properties": {
        "EndpointGroupRegion": "cn-beijing",
        "AcceleratorId": {
          "Ref": "AcceleratorId"
        },
        "EndpointConfigurations": [
          {
            "Type": "Ip",
            "Endpoint": "10.10.10.1",
            "Weight": 100
          }
        ],
        "Name": "TestEndpointGroup",
        "ListenerId": {
          "Ref": "ListenerId"
        }
      }
    }
  },
  "Outputs": {
    "EndpointGroupId": {
      "Description": "エンドポイントグループの ID。", // The ID of the endpoint group.
      "Value": {
        "Fn::GetAtt": [
          "EndpointGroup",
          "EndpointGroupId"
        ]
      }
    }
  }
}