Resource Orchestration Service ALIYUN::GA::EndpointGroups 構文プロパティと例 - ROS

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

構文

{
  "Type": "ALIYUN::GA::EndpointGroups",
  "Properties": {
    "AcceleratorId": String,
    "EndpointGroupConfigurations": List,
    "ListenerId": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AcceleratorId	String	はい	いいえ	Global Accelerator (GA) インスタンスの ID。	なし。
EndpointGroupConfigurations	List	はい	いいえ	エンドポイントグループの構成。	詳細については、「EndpointGroupConfigurations プロパティ」をご参照ください。
ListenerId	String	はい	いいえ	リスナー ID。	説明リスナーのプロトコルが HTTP または HTTPS の場合、一度に作成できるエンドポイントグループは 1 つだけです。

EndpointGroupConfigurations 構文

"EndpointGroupConfigurations": [
  {
    "HealthCheckIntervalSeconds": Integer,
    "TrafficPercentage": Integer,
    "EndpointGroupName": String,
    "HealthCheckPath": String,
    "ThresholdCount": Integer,
    "HealthCheckEnabled": Boolean,
    "EndpointRequestProtocol": String,
    "PortOverrides": List,
    "EndpointGroupRegion": String,
    "EndpointGroupDescription": String,
    "EnableClientIPPreservationToa": Boolean,
    "HealthCheckProtocol": String,
    "HealthCheckPort": Integer,
    "EndpointConfigurations": List,
    "Tags": List,
    "EndpointGroupType": String,
    "EnableClientIPPreservationProxyProtocol": Boolean
  }
]

EndpointGroupConfigurations プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EndpointGroupRegion	String	はい	いいえ	エンドポイントグループのリージョン ID。	なし。
EndpointGroupName	String	いいえ	いいえ	エンドポイントグループの名前。	なし。
EndpointRequestProtocol	String	いいえ	いいえ	バックエンドサービスで使用されるプロトコル。	有効な値: [HTTP] [HTTPS]
EndpointGroupDescription	String	いいえ	いいえ	エンドポイントグループの説明。	なし。
EnableClientIPPreservationToa	Boolean	いいえ	いいえ	TCP Option Address (TOA) モジュールを使用してクライアント IP アドレスを保持するかどうかを指定します。	有効な値: [true] [false] (デフォルト)
EndpointConfigurations	List	いいえ	いいえ	エンドポイントの構成。	詳細については、「EndpointConfigurations プロパティ」をご参照ください。
EndpointGroupType	String	いいえ	いいえ	エンドポイントグループのタイプ。	有効な値: [default] [virtual]
EnableClientIPPreservationProxyProtocol	Boolean	いいえ	いいえ	プロキシプロトコルを使用してクライアント IP アドレスを保持するかどうかを指定します。	有効な値: [true] [false] (デフォルト)
HealthCheckIntervalSeconds	Integer	いいえ	いいえ	システムがヘルスチェックを実行する間隔。	単位: 秒。
HealthCheckPath	String	いいえ	いいえ	システムがヘルスチェックを実行するパス。	なし。
HealthCheckEnabled	Boolean	いいえ	いいえ	ヘルスチェック機能を有効にするかどうかを指定します。	有効な値: [true] [false]
HealthCheckProtocol	String	いいえ	いいえ	システムがヘルスチェックを実行するプロトコル。	[tcp] [http] [https]
HealthCheckPort	Integer	いいえ	いいえ	ヘルスチェックに使用するポート。	なし。
PortOverrides	List	いいえ	いいえ	ポートマッピング。	詳細については、「PortOverrides プロパティ」をご参照ください。
TrafficPercentage	Integer	いいえ	いいえ	リスナーが複数のエンドポイントグループに関連付けられている場合のエンドポイントグループのトラフィック比率。	なし。
ThresholdCount	Integer	いいえ	いいえ	正常なエンドポイントが異常と宣言される前に、ヘルスチェックに連続して失敗する必要がある回数。	なし。
Tags	List	いいえ	いいえ	エンドポイントグループのタグ。	詳細については、「Tags プロパティ」をご参照ください。

PortOverrides 構文

"PortOverrides": [
  {
    "ListenerPort": Integer,
    "EndpointPort": Integer
  }
]

PortOverrides プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EndpointPort	Integer	はい	いいえ	エンドポイントポート。	なし。
ListenerPort	Integer	はい	いいえ	リスナーポート。	なし。

EndpointConfigurations 構文

"EndpointConfigurations": [
  {
    "Type": String,
    "Endpoint": String,
    "SubAddress": String,
    "Weight": Integer
  }
]

EndpointConfigurations プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Endpoint	String	はい	いいえ	Type プロパティの値に対応する IP アドレス、ドメイン名、またはインスタンス ID。	なし。
Type	String	はい	いいえ	エンドポイントタイプ。	有効な値: [Domain]: カスタムドメイン名 [Ip]: カスタム IP アドレス [PublicIp]: Alibaba Cloud によって提供されるパブリック IP アドレス [ECS]: Elastic Compute Service (ECS) インスタンス [SLB]: Server Load Balancer (SLB) インスタンス [ALB]: Application Load Balancer インスタンス [OSS]: Object Storage Service (OSS) バケット [ENI]: 弾性ネットワークインターフェース (ENI) [NLB]: Network Load Balancer インスタンス
Weight	Integer	はい	いいえ	エンドポイントの重み。	なし。
SubAddress	String	いいえ	いいえ	ENI のプライベート IP アドレス。	なし。

Tags 構文

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

Tags プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	いいえ	いいえ	エンドポイントグループのタグキー。	なし。
Value	String	いいえ	いいえ	エンドポイントグループのタグ値。	なし。

戻り値

Fn::GetAtt

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

例

説明

AcceleratorId プロパティや ListenerId プロパティなどのプロパティのマスクされた値は、ビジネス要件に基づいて変更する必要があります。

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionResource:
    Type: ALIYUN::GA::EndpointGroups
    Properties:
      EndpointGroupConfigurations:
        - EndpointGroupName: test382
          EndpointGroupDescription: test_endpoint_group_382
          EndpointGroupRegion: cn-beijing
          TrafficPercentage: 100
          HealthCheckEnabled: false
          HealthCheckIntervalSeconds: 0
          EndpointGroupType: default
          EndpointConfigurations:
            - EnableProxyProtocol: false
              Type: OSS
              EnableClientIPPreservation: false
              Endpoint: beijing-test-delete
              Weight: 255
          Tags:
            - Value: c2
              Key: c2
            - Value: d1
              Key: d1
      AcceleratorId: ga-bp1odcab8tmno0hdq****
      ListenerId: lsr-bp1bpn0kn908w4nbw****
Outputs:
  EndpointGroupIds:
    Description: The IDs of the endpoint groups.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EndpointGroupIds

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::GA::EndpointGroups",
      "Properties": {
        "EndpointGroupConfigurations": [
                {
                    "EndpointGroupName": "test382",
                    "EndpointGroupDescription": "test_endpoint_group_382",
                    "EndpointGroupRegion": "cn-beijing",
                    "TrafficPercentage": 100,
                    "HealthCheckEnabled": false,
                    "HealthCheckIntervalSeconds": 0,
                    "EndpointGroupType": "default",
                    "EndpointConfigurations": [
                        {
                            "EnableProxyProtocol": false,
                            "Type": "OSS",
                            "EnableClientIPPreservation": false,
                            "Endpoint": "beijing-test-delete",
                            "Weight": 255
                        }
                    ],
                    "Tags": [
                        {
                            "Value": "c2",
                            "Key": "c2"
                        },
                        {
                            "Value": "d1",
                            "Key": "d1"
                        }
                    ],
                }
            ],
        "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
        "ListenerId": "lsr-bp1bpn0kn908w4nbw****"
      }
    }
  },
  "Outputs": {
    "EndpointGroupIds": {
      "Description": "エンドポイントグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EndpointGroupIds"
        ]
      }
    }
  }
}

構文

プロパティ

EndpointGroupConfigurations 構文

EndpointGroupConfigurations プロパティ

PortOverrides 構文

PortOverrides プロパティ

EndpointConfigurations 構文

EndpointConfigurations プロパティ

Tags 構文

Tags プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式