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

構文

{
  "Type": "ALIYUN::GA::Listener",
  "Properties": {
    "Description": String,
    "PortRanges": List,
    "Protocol": String,
    "AcceleratorId": String,
    "Name": String,
    "ClientAffinity": String,
    "Certificates": List,
    "SecurityPolicyId": String,
    "ProxyProtocol": Boolean,
    "XForwardedForConfig": Map
  }
}

プロパティ

プロパティ	タイプ	必須	更新可能	説明	制約
Description	String	いいえ	はい	リスナーの説明。	なし
PortRanges	List	はい	はい	リスニングポート。	最大 10 個のリスニングポートをサポートします。詳細については、「PortRanges プロパティ」をご参照ください。
Protocol	String	はい	はい	リスナーのネットワークトランスポートプロトコル。	有効な値： tcp：TCP。 udp：UDP。 http：HTTP。 https：HTTPS。
AcceleratorId	String	はい	いいえ	GA インスタンスの ID。	なし
Name	String	いいえ	はい	リスナーの名前。	名前は 2 文字以上 128 文字以下にする必要があります。名前は英字または漢字で始める必要があります。名前には、英字、漢字、数字、アンダースコア (_)、ハイフン (-) を使用できます。
ClientAffinity	String	いいえ	はい	クライアントアフィニティの設定。	有効な値： None (デフォルト)：クライアントアフィニティなし。同じクライアントからのリクエストが同じエンドポイントに転送されることは保証されません。 SOURCE_IP：クライアントアフィニティが維持されます。クライアントがステートフルアプリケーションにアクセスする場合、そのクライアントからのすべてのリクエストは、送信元ポートやプロトコルに関係なく、同じエンドポイントに転送されます。
Certificates	List	いいえ	はい	SSL 証明書。	詳細については、「Certificates プロパティ」をご参照ください。
SecurityPolicyId	String	いいえ	はい	セキュリティポリシーの ID。	有効な値： tls_cipher_policy_1_0 対応 TLS バージョン：TLSv1.0、TLSv1.1、TLSv1.2。対応暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、DES-CBC3-SHA。 tls_cipher_policy_1_1 対応 TLS バージョン：TLSv1.1、TLSv1.2。対応暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、DES-CBC3-SHA。 tls_cipher_policy_1_2 対応 TLS バージョン：TLSv1.2。対応暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、DES-CBC3-SHA。 tls_cipher_policy_1_2_strict 対応 TLS バージョン：TLSv1.2。対応暗号スイート：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。 tls_cipher_policy_1_2_strict_with_1_3 対応 TLS バージョン：TLSv1.2、TLSv1.3。対応暗号スイート：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。説明このパラメータは HTTPS リスナーでのみ使用できます。
ProxyProtocol	ブール値	いいえ	はい	クライアントのソース IP アドレスを保持するかどうかを指定します。	有効な値： true：クライアントのソース IP アドレスを保持します。この機能を有効にすると、バックエンドサービスはクライアントのソース IP アドレスを確認できます。 false (デフォルト)：クライアントのソース IP アドレスを保持しません。説明このパラメータは、リスナー API を使用して設定されなくなりました。エンドポイントグループの API を使用してこのパラメータを設定してください。 Proxy Protocol の詳細については、「CreateEndpointGroup」および「UpdateEndpointGroup」をご参照ください。
XForwardedForConfig	Map	いいえ	はい	X-Forwarded-For ヘッダーフィールドの設定。	詳細については、「XForwardedForConfig プロパティ」をご参照ください。

Certificates の構文

"Certificates": [
 {
    "Id": String
  }
]

Certificates のプロパティ

プロパティ名	タイプ	必須	更新可能	説明	制約
Id	String	はい	はい	SSL 証明書の ID。	説明このパラメータは HTTPS リスナーでのみ必須です。

XForwardedForConfig の構文

"XForwardedForConfig": {
 "XRealIpEnabled": Boolean,
 "XForwardedForGaIdEnabled": Boolean,
 "XForwardedForGaApEnabled": Boolean,
 "XForwardedForPortEnabled": Boolean,
 "XForwardedForProtoEnabled": Boolean
}

XForwardedForConfig のプロパティ

プロパティ名	タイプ	必須	更新可能	説明	制約
XRealIpEnabled	ブール値	いいえ	はい	X-Real-IP ヘッダーを使用してクライアントの実際の IP アドレスを取得するかどうかを指定します。	有効な値： true：X-Real-IP ヘッダーを使用してクライアントの実際の IP アドレスを取得します。 false (デフォルト)：X-Real-IP ヘッダーを使用してクライアントの実際の IP アドレスを取得しません。説明このパラメータは HTTP リスナーおよび HTTPS リスナーでのみ使用できます。
XForwardedForGaIdEnabled	ブール値	いいえ	はい	GA-ID ヘッダーを使用して GA インスタンスの ID を取得するかどうかを指定します。	有効な値： true：GA-ID ヘッダーを使用して GA インスタンスの ID を取得します。 false (デフォルト)：GA-ID ヘッダーを使用して GA インスタンスの ID を取得しません。説明このパラメータは HTTP リスナーおよび HTTPS リスナーでのみ使用できます。
XForwardedForGaApEnabled	ブール値	いいえ	はい	GA-AP ヘッダーを使用して加速リージョン情報を取得するかどうかを指定します。	有効な値： true：GA-AP ヘッダーを使用して加速リージョン情報を取得します。 false (デフォルト)：GA-AP ヘッダーを使用して加速リージョン情報を取得しません。説明このパラメータは HTTP リスナーおよび HTTPS リスナーでのみ使用できます。
XForwardedForPortEnabled	ブール値	いいえ	はい	GA-X-Forward-Port ヘッダーを使用して GA インスタンスのリスニングポートを取得するかどうかを指定します。	有効な値： true：GA-X-Forward-Port ヘッダーを使用して GA インスタンスのリスニングポートを取得します。 false (デフォルト)：GA-X-Forward-Port ヘッダーを使用して GA インスタンスのリスニングポートを取得しません。説明このパラメータは HTTP リスナーおよび HTTPS リスナーでのみ使用できます。
XForwardedForProtoEnabled	ブール値	いいえ	はい	GA-X-Forward-Proto ヘッダーを使用して GA インスタンスのリスニングプロトコルを取得するかどうかを指定します。	有効な値： true：GA-X-Forward-Proto ヘッダーを使用して GA インスタンスのリスニングプロトコルを取得します。 false (デフォルト)：GA-X-Forward-Proto ヘッダーを使用して GA インスタンスのリスニングプロトコルを取得しません。説明このパラメータは HTTP リスナーおよび HTTPS リスナーでのみ使用できます。

PortRanges の構文

"PortRanges": [
  {
    "FromPort": Integer,
    "ToPort": Integer
  }
]

PortRanges のプロパティ

プロパティ名	タイプ	必須	更新可能	説明	制約
FromPort	Integer	はい	はい	エンドポイントへのリクエストを受信および転送するリスニングポート範囲の、開始ポートを指定します。	なし
ToPort	Integer	はい	はい	エンドポイントへのリクエストを受信および転送するリスニングポート範囲の、終了ポートを指定します。	なし

戻り値

Fn::GetAtt

ListenerId：リスナーの ID。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AcceleratorId:
    Type: String
    Description: リスナーを追加する GA インスタンスの ID。
Resources:
  Listener:
    Type: ALIYUN::GA::Listener
    Properties:
      PortRanges:
        - FromPort: 335
          ToPort: 336
      Protocol: tcp
      AcceleratorId:
        Ref: AcceleratorId
      Name: TestListener
      ClientAffinity: None
Outputs:
  ListenerId:
    Description: リスナーの ID。
    Value:
      Fn::GetAtt:
        - Listener
        - ListenerId

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AcceleratorId": {
      "Type": "String",
      "Description": "リスナーを追加する GA インスタンスの ID。"
    }
  },
  "Resources": {
    "Listener": {
      "Type": "ALIYUN::GA::Listener",
      "Properties": {
        "PortRanges": [
          {
            "FromPort": 335,
            "ToPort": 336
          }
        ],
        "Protocol": "tcp",
        "AcceleratorId": {
          "Ref": "AcceleratorId"
        },
        "Name": "TestListener",
        "ClientAffinity": "None"
      }
    }
  },
  "Outputs": {
    "ListenerId": {
      "Description": "リスナーの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Listener",
          "ListenerId"
        ]
      }
    }
  }
}