すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::GA::Listener

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::GA::Listener

    最終更新日:Jan 16, 2025

    ALIYUN::GA::Listener は、Global Accelerator（GA）インスタンスのリスナーを作成するために使用されます。

    構文

    {
  "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
  }
}

    プロパティ

    プロパティタイプ必須編集可能説明制約
    DescriptionStringいいえはいリスナーの説明。なし。
    PortRangesListはいはいリスナーポート。最大 10 個のリスナーポートを指定できます。

    詳細については、PortRanges プロパティをご参照ください。

    ProtocolStringはいはいリスナーで使用されるネットワーク伝送プロトコル。有効な値：
    • tcp: TCP
    • udp: UDP
    • http: HTTP
    • https: HTTPS
    AcceleratorIdStringはいいいえGA インスタンスの ID。なし。
    NameStringいいえはいリスナーの名前。名前は 2 ～ 128 文字で、数字、文字、アンダースコア（_）、ハイフン（-）を含めることができます。名前は文字で始める必要があります。
    ClientAffinityStringいいえはいリスナーのクライアントアフィニティを有効にするかどうかを指定します。デフォルト値：なし。有効な値：
    • None: クライアントアフィニティを無効にします。このモードでは、クライアント IP アドレスからのリクエストは、常に同じエンドポイントに転送されるとは限りません。
    • SOURCE_IP: クライアントアフィニティを有効にします。このモードでは、ステートフルアプリケーションへのクライアント IP アドレスからのリクエストは、使用される送信元ポートまたはプロトコルに関係なく、同じエンドポイントに転送されます。
    CertificatesListいいえはいSSL 証明書。詳細については、Certificates プロパティをご参照ください。
    SecurityPolicyIdStringいいえはいセキュリティポリシーの ID。有効な値：
    • tls_cipher_policy_1_0
      • サポートされている Transport Layer Security（TLS）バージョン：TLS 1.0、TLS 1.1、TLS 1.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 バージョン：TLS 1.1、TLS 1.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 バージョン：TLS 1.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 バージョン：TLS 1.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 バージョン：TLS 1.2、TLS 1.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 リスナーに対してのみ指定できます。
    ProxyProtocolBooleanいいえはいクライアントの送信元 IP アドレスを保持するかどうかを指定します。デフォルト値：false。有効な値：
    • true: クライアントの送信元 IP アドレスを保持します。

      このプロパティを true に設定すると、バックエンドサーバーでクライアントの送信元 IP アドレスを表示できます。

    • false: クライアントの送信元 IP アドレスを保持しません。
    説明 このパラメーターは、リスナーの設定に使用される API 操作からは非推奨になります。エンドポイントグループを設定するために API 操作を呼び出すときに、このパラメーターを設定することをお勧めします。

    詳細については、「CreateEndpointGroup」および「UpdateEndpointGroup」をご参照ください。

    XForwardedForConfigMapいいえはいXForward ヘッダーの構成。詳細については、XForwardedForConfig プロパティをご参照ください。

    Certificates 構文

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

    Certificates プロパティ

    プロパティタイプ必須編集可能説明制約
    IdStringはいはいSSL 証明書の ID。
    説明 このパラメーターは、HTTPS リスナーの場合にのみ必須です。

    XForwardedForConfig 構文

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

    XForwardedForConfig プロパティ

    プロパティタイプ必須編集可能説明制約
    XRealIpEnabledBooleanいいえはいX-Real-IP ヘッダーを使用してクライアント IP アドレスを取得するかどうかを指定します。デフォルト値：false。有効な値：
    • true: X-Real-IP ヘッダーを使用してクライアント IP アドレスを取得します。
    • false: X-Real-IP ヘッダーを使用してクライアント IP アドレスを取得しません。
    説明 このプロパティは、HTTP および HTTPS リスナーに対してのみ指定できます。
    XForwardedForGaIdEnabledBooleanいいえはいGA-ID ヘッダーを使用して GA インスタンスの ID を取得するかどうかを指定します。デフォルト値：false。有効な値：
    • true: GA-ID ヘッダーを使用して GA インスタンスの ID を取得します。
    • false: GA-ID ヘッダーを使用して GA インスタンスの ID を取得しません。
    説明 このプロパティは、HTTP および HTTPS リスナーに対してのみ指定できます。
    XForwardedForGaApEnabledBooleanいいえはいGA-AP ヘッダーを使用して、アクセラレーションリージョンに関する情報を取得するかどうかを指定します。デフォルト値：false。有効な値：
    • true: GA-AP ヘッダーを使用して、アクセラレーションリージョンに関する情報を取得します。
    • false: GA-AP ヘッダーを使用して、アクセラレーションリージョンに関する情報を取得しません。
    説明 このプロパティは、HTTP および HTTPS リスナーに対してのみ指定できます。
    XForwardedForPortEnabledBooleanいいえはいGA-X-Forward-Port ヘッダーを使用して GA インスタンスのリスナーポートを取得するかどうかを指定します。デフォルト値：false。有効な値：
    • true: GA-X-Forward-Port ヘッダーを使用して GA インスタンスのリスナーポートを取得します。
    • false: GA-X-Forward-Port ヘッダーを使用して GA インスタンスのリスナーポートを取得しません。
    説明 このプロパティは、HTTP および HTTPS リスナーに対してのみ指定できます。
    XForwardedForProtoEnabledBooleanいいえはいGA-X-Forward-Proto ヘッダーを使用して GA インスタンスのリスナープロトコルを取得するかどうかを指定します。デフォルト値：false。有効な値：
    • true: GA-X-Forward-Proto ヘッダーを使用して GA インスタンスのリスナープロトコルを取得します。
    • false: GA-X-Forward-Proto ヘッダーを使用して GA インスタンスのリスナープロトコルを取得しません。
    説明 このプロパティは、HTTP および HTTPS リスナーに対してのみ指定できます。

    PortRanges 構文

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

    PortRanges プロパティ

    プロパティタイプ必須編集可能説明制約
    FromPortIntegerはいはいリクエストを受信し、エンドポイントに転送するために使用されるリスナーポートの範囲の最初のポート。なし。
    ToPortIntegerはいはいリクエストを受信し、エンドポイントに転送するために使用されるリスナーポートの範囲の最後のポート。なし。

    レスポンスパラメーター

    Fn::GetAtt

    ListenerId: リスナーの ID。

    例

    • YAML 形式

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AcceleratorId:
    Type: String
    Description: リスナーを追加する Global Accelerator インスタンスの ID。
Resources:
  Listener:
    Type: ALIYUN::GA::Listener
    Properties:
      PortRanges:
        - FromPort: 336
          ToPort: 335
      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": "リスナーを追加する Global Accelerator インスタンスの ID。" // The ID of the Global Accelerator instance to which the listener will be added.
    }
  },
  "Resources": {
    "Listener": {
      "Type": "ALIYUN::GA::Listener",
      "Properties": {
        "PortRanges": [
          {
            "FromPort": 336,
            "ToPort": 335
          }
        ],
        "Protocol": "tcp",
        "AcceleratorId": {
          "Ref": "AcceleratorId"
        },
        "Name": "TestListener",
        "ClientAffinity": "NONE"
      }
    }
  },
  "Outputs": {
    "ListenerId": {
      "Description": "リスナーの ID。", // The ID of the listener.
      "Value": {
        "Fn::GetAtt": [
          "Listener",
          "ListenerId"
        ]
      }
    }
  }
}