すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ALB::Listener

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ALB::Listener

    最終更新日:Apr 02, 2025

    ALIYUN::ALB::Listener は、HTTP、HTTPS、または Quick UDP Internet Connections (QUIC) リスナーを作成するために使用されます。

    構文

    {
  "Type": "ALIYUN::ALB::Listener",
  "Properties": {
    "RequestTimeout": Integer, // リクエストのタイムアウト期間
    "ListenerPort": Integer, // リスナーポート
    "Http2Enabled": Boolean, // HTTP/2 を有効にするかどうか
    "DefaultActions": List, // 転送ルールの操作
    "Certificates": List, // 証明書
    "IdleTimeout": Integer, // アイドル接続のタイムアウト期間
    "LoadBalancerId": String, // Application Load Balancer (ALB) インスタンスの ID
    "ListenerProtocol": String, // リスナーのプロトコル
    "QuicConfig": Map, // ALB インスタンスの HTTPS リスナーに関連付ける QUIC リスナーの構成
    "GzipEnabled": Boolean, // 特定の種類のファイルを圧縮するために GNU zip (Gzip) 圧縮を有効にするかどうか
    "SecurityPolicyId": String, // セキュリティポリシーの ID
    "ListenerDescription": String, // リスナーの説明
    "XForwardedForConfig": Map, // X-Forwarded-For ヘッダーの構成
    "CaEnabled": Boolean, // 相互認証を有効にするかどうか
    "CaCertificates": List, // 認証局 (CA) 証明書
    "ListenerStatus": String, // リスナーの状態
    "LogConfig": Map // ログの設定
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    DefaultActions

    List

    はい

    はい

    転送ルールの操作。

    有効な値:

    [
        {
          "ForwardGroupConfig": { // 操作の設定
            "ServerGroupTuples": [ // リクエストの転送先サーバーグループ
              {
                "ServerGroupId": "sgp-46ndzg2wz4v5mp****" // リクエストの転送先サーバーグループの ID
              }
            ]
          },
          "Type": "ForwardGroup" // 操作。ForwardGroup に設定します。この値は、リクエストが複数のサーバーグループに転送されることを指定します。
        }
      ]

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

    ListenerPort

    Integer

    はい

    いいえ

    リスナーポート。

    有効な値: 1 ～ 65535。

    ListenerProtocol

    String

    はい

    いいえ

    リスナーのプロトコル。

    有効な値:

    • HTTP

    • HTTPS

    • QUIC

    LoadBalancerId

    String

    はい

    いいえ

    Application Load Balancer (ALB) インスタンスの ID。

    なし。

    CaCertificates

    List

    いいえ

    はい

    認証局 (CA) 証明書。

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

    CaEnabled

    Boolean

    いいえ

    はい

    相互認証を有効にするかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    Certificates

    List

    いいえ

    はい

    証明書。

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

    GzipEnabled

    Boolean

    いいえ

    はい

    特定の種類のファイルを圧縮するために GNU zip (Gzip) 圧縮を有効にするかどうかを指定します。

    有効な値:

    • true (false)

    • false

    Http2Enabled

    Boolean

    いいえ

    はい

    HTTP/2 を有効にするかどうかを指定します。

    有効な値:

    • true (デフォルト)

    • false

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    IdleTimeout

    Integer

    いいえ

    はい

    アイドル接続のタイムアウト期間。

    有効な値: 1 ～ 60。

    デフォルト値: 15。

    単位: 秒。

    指定されたタイムアウト期間内にリクエストが受信されない場合、ALB は現在の接続を閉じます。別のリクエストが受信されると、ALB は新しい接続を確立します。

    ListenerDescription

    String

    いいえ

    はい

    リスナーの説明。

    説明は 2 ～ 256 文字でなければなりません。

    ListenerStatus

    String

    いいえ

    はい

    リスナーの状態。

    有効な値:

    • Running

    • Stopped

    QuicConfig

    Map

    いいえ

    はい

    ALB インスタンスの HTTPS リスナーに関連付ける QUIC リスナーの構成。

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

    RequestTimeout

    Integer

    いいえ

    はい

    リクエストのタイムアウト期間。

    有効な値: 1 ～ 180。

    デフォルト値: 60。

    単位: 秒。

    指定されたタイムアウト期間内にバックエンドサーバーから応答が受信されない場合、ALB は応答の待機を停止し、クライアントに HTTP 504 状態コードを返します。

    SecurityPolicyId

    String

    いいえ

    はい

    セキュリティポリシーの ID。

    システムセキュリティポリシーとカスタムセキュリティポリシーがサポートされています。

    デフォルト値: tls_cipher_policy_1_0。この値は、システムセキュリティポリシーを指定します。

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForConfig

    Map

    いいえ

    はい

    X-Forwarded-For ヘッダーの構成。

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

    LogConfig

    Map

    いいえ

    はい

    ログの設定。

    詳細については、このトピックの「LogConfig プロパティ」セクションをご参照ください。

    DefaultActions 構文

    "DefaultActions": [
  {
    "Type": String, // 操作
    "ForwardGroupConfig": Map // 操作の設定
  }
]

    DefaultActions プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    ForwardGroupConfig

    Map

    はい

    はい

    操作の構成。

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

    Type

    String

    はい

    はい

    操作。

    ForwardGroup に設定します。この値は、リクエストが複数のサーバーグループに転送されることを指定します。

    ForwardGroupConfig 構文

    "ForwardGroupConfig": {
  "ServerGroupTuples": List // リクエストの転送先サーバーグループ
}

    ForwardGroupConfig プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    ServerGroupTuples

    List

    はい

    はい

    リクエストの転送先サーバーグループ。

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

    ServerGroupTuples 構文

    "ServerGroupTuples": [
  {
    "ServerGroupId": String // リクエストの転送先サーバーグループの ID
  }
]

    ServerGroupTuples プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    ServerGroupId

    String

    はい

    はい

    リクエストの転送先サーバーグループの ID。

    なし。

    Certificates 構文

    "Certificates": [
  {
    "CertificateId": String // 証明書 ID
  }
]

    Certificates プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    CertificateId

    String

    いいえ

    はい

    証明書 ID。

    サーバー証明書のみがサポートされています。

    QuicConfig 構文

    "QuicConfig": {
  "QuicListenerId": String, // QUIC リスナーの ID
  "QuicUpgradeEnabled": Boolean // QUIC アップグレードを有効にするかどうか
}

    QuicConfig プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    QuicListenerId

    String

    いいえ

    はい

    QUIC リスナーの ID。

    QuicUpgradeEnabled を true に設定した場合、このプロパティは必須です。

    説明

    • このプロパティは、HTTPS リスナーに対してのみ構成できます。

    • HTTPS リスナーと QUIC リスナーを同じ ALB インスタンスに追加する必要があります。また、QUIC リスナーが別のリスナーに関連付けられていないことを確認してください。

    QuicUpgradeEnabled

    Boolean

    いいえ

    はい

    QUIC アップグレードを有効にするかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    LogConfig 構文

    "LogConfig": {
  "AccessLogTracingConfig": Map, // アクセスログのトレース設定
  "AccessLogRecordCustomizedHeadersEnabled": Boolean // アクセスログにカスタムヘッダーを記録するかどうか
}

    LogConfig プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    AccessLogTracingConfig

    Map

    いいえ

    はい

    アクセスログのトレース設定。

    詳細については、このトピックの「AccessLogTracingConfig プロパティ」セクションをご参照ください。

    AccessLogRecordCustomizedHeadersEnabled

    Boolean

    いいえ

    はい

    アクセスログにカスタムヘッダーを記録するかどうかを指定します。

    有効な値:

    • true

    • false

    AccessLogTracingConfig 構文

    "AccessLogTracingConfig": {
  "TracingSample": Integer, // トレースのサンプリングレート
  "TracingType": String, // トレースのタイプ
  "TracingEnabled": Boolean // トレース機能を有効にするかどうか
}

    AccessLogTracingConfig プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    TracingSample

    Integer

    いいえ

    はい

    トレースのサンプリングレート。

    有効な値: 1 ～ 10000。

    説明

    このプロパティは、TracingEnabled が true に設定されている場合にのみ有効になります。

    TracingType

    String

    いいえ

    はい

    トレースのタイプ。

    値を Zipkin に設定します。

    説明

    このプロパティは、TracingEnabled が true に設定されている場合にのみ有効になります。

    TracingEnabled

    Boolean

    いいえ

    はい

    トレース機能を有効にするかどうかを指定します。

    有効な値:

    • true

    • false

    説明

    ALB インスタンスのアクセスログ機能を有効にするには、AccessLogEnabled を true に設定した場合にのみ、TracingEnabled を true に設定できます。

    XForwardedForConfig 構文

    "XForwardedForConfig": {
  "XForwardedForClientCertFingerprintAlias": String, // カスタムヘッダーの名前。クライアント証明書のフィンガープリントを照会するために使用できます。
  "XForwardedForClientCertFingerprintEnabled": Boolean, // X-Forwarded-Clientcert-fingerprint ヘッダーを使用してクライアント証明書のフィンガープリントを照会するかどうかを指定します。
  "XForwardedForClientCertIssuerDNAlias": String, // カスタムヘッダーの名前。クライアント証明書を発行した認証局 (CA) に関する情報を照会するために使用できます。
  "XForwardedForClientCertClientVerifyAlias": String, // カスタムヘッダーの名前。クライアント証明書の検証結果を照会するために使用できます。
  "XForwardedForSLBIdEnabled": Boolean, // SLB-ID ヘッダーを使用して ALB インスタンスの ID を照会するかどうかを指定します。
  "XForwardedForClientCertSubjectDNEnabled": Boolean, // X-Forwarded-Clientcert-subjectdn ヘッダーを使用してクライアント証明書の所有者に関する情報を照会するかどうかを指定します。
  "XForwardedForClientCertSubjectDNAlias": String, // カスタムヘッダーの名前。クライアント証明書の所有者に関する情報を照会するために使用できます。
  "XForwardedForProtoEnabled": Boolean, // X-Forwarded-Proto ヘッダーを使用して ALB インスタンスのリスナー・プロトコルを照会するかどうかを指定します。
  "XForwardedForClientSrcPortEnabled": Boolean, // X-Forwarded-Client-Port ヘッダーを使用してクライアント・ポートを照会するかどうかを指定します。
  "XForwardedForSLBPortEnabled": Boolean, // X-Forwarded-Port ヘッダーを使用して ALB インスタンスのリスナー・ポートを照会するかどうかを指定します。
  "XForwardedForEnabled": Boolean, // X-Forwarded-For ヘッダーを使用してクライアントの実際の IP アドレスを照会するかどうかを指定します。
  "XForwardedForClientCertIssuerDNEnabled": Boolean, // X-Forwarded-Clientcert-issuerdn ヘッダーを使用してクライアント証明書を発行した CA に関する情報を照会するかどうかを指定します。
  "XForwardedForClientCertClientVerifyEnabled": Boolean, // X-Forwarded-Clientcert-clientverify ヘッダーを使用してクライアント証明書の検証結果を照会するかどうかを指定します。
  "XForwardedForClientSourceIpsEnabled": Boolean, // X-Forwarded-Client-SourceIps ヘッダーを使用してクライアントの送信元ポートを照会するかどうかを指定します。
  "XForwardedForClientSourceIpsTrusted": String, // 信頼できるプロキシ IP アドレス。
  "XForwardedForProcessingMode": String, // X-Forwarded-For ヘッダーを処理する方法。
  "XForwardedForHostEnabled": Boolean // X-Forwarded-Host ヘッダーを使用して ALB インスタンスのクライアントドメイン名を照会するかどうかを指定します。
}

    XForwardedForConfig プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    XForwardedForClientCertClientVerifyAlias

    String

    いいえ

    はい

    カスタムヘッダーの名前。クライアント証明書の検証結果を照会するために使用できます。

    このプロパティは、XForwardedForClientCertClientVerifyEnabled を true に設定した場合にのみ有効になります。

    名前は 1 ～ 40 文字で、小文字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientCertClientVerifyEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Clientcert-clientverify ヘッダーを使用して、クライアント証明書の検証結果を照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientCertFingerprintAlias

    String

    いいえ

    はい

    カスタムヘッダーの名前。クライアント証明書のフィンガープリントを照会するために使用できます。

    このプロパティは、XForwardedForClientCertFingerprintEnabled を true に設定した場合にのみ有効になります。

    名前は 1 ～ 40 文字で、小文字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientCertFingerprintEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Clientcert-fingerprint ヘッダーを使用して、クライアント証明書のフィンガープリントを照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientCertIssuerDNAlias

    String

    いいえ

    はい

    カスタムヘッダーの名前。クライアント証明書を発行した認証局 (CA) に関する情報を照会するために使用できます。

    このプロパティは、XForwardedForClientCertIssuerDNEnabled を true に設定した場合にのみ有効になります。

    名前は 1 ～ 40 文字で、小文字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientCertIssuerDNEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Clientcert-issuerdn ヘッダーを使用して、クライアント証明書を発行した CA に関する情報を照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientCertSubjectDNAlias

    String

    いいえ

    はい

    カスタムヘッダーの名前。クライアント証明書の所有者に関する情報を照会するために使用できます。

    このプロパティは、XForwardedForClientCertSubjectDNEnabled を true に設定した場合にのみ有効になります。

    名前は 1 ～ 40 文字で、小文字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientCertSubjectDNEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Clientcert-subjectdn ヘッダーを使用して、クライアント証明書の所有者に関する情報を照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    説明

    このプロパティは、HTTPS リスナーに対してのみ構成できます。

    XForwardedForClientSourceIpsEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Client-SourceIps ヘッダーを使用して、クライアントの送信元ポートを照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    XForwardedForClientSourceIpsTrusted

    String

    いいえ

    はい

    信頼できるプロキシ IP アドレス。

    ALB インスタンスは、X-Forwarded-For ヘッダー内の IP アドレスを右端の IP アドレスから左端の IP アドレスまで走査します。信頼できる IP アドレスリストにない最初の IP アドレスがクライアント IP アドレスと見なされます。クライアント IP アドレスからのリクエストはスロットルされます。

    XForwardedForClientSrcPortEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Client-Port ヘッダーを使用して、クライアントポートを照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    説明

    このプロパティは、HTTP リスナーと HTTPS リスナーに対して構成できます。

    XForwardedForEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-For ヘッダーを使用して、クライアントの実際の IP アドレスを照会するかどうかを指定します。

    有効な値:

    • true (デフォルト)

    • false

    説明

    このプロパティは、HTTP リスナーと HTTPS リスナーに対して構成できます。

    XForwardedForProtoEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Proto ヘッダーを使用して、ALB インスタンスのリスナー・プロトコルを照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    XForwardedForSLBIdEnabled

    Boolean

    いいえ

    はい

    SLB-ID ヘッダーを使用して、ALB インスタンスの ID を照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    XForwardedForSLBPortEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Port ヘッダーを使用して、ALB インスタンスのリスナー・ポートを照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    XForwardedForProcessingMode

    String

    いいえ

    はい

    X-Forwarded-For ヘッダーを処理する方法。

    このプロパティは、XForwardedForEnabled が true に設定されている場合にのみ有効になります。有効な値:

    • append (デフォルト)

    • remove

    説明

    • XForwardedForProcessingMode を append に設定すると、ALB はリクエスト内の既存の X-Forwarded-For ヘッダーに最後のホップの IP アドレスを追加してから、リクエストをバックエンドサーバーに送信します。

    • XForwardedForProcessingMode を remove に設定すると、リクエストに X-Forwarded-For ヘッダーが含まれているかどうかに関係なく、ALB はバックエンドサーバーにリクエストを送信する前に、リクエスト内の X-Forwarded-For ヘッダーを削除します。

    • HTTP リスナーと HTTPS リスナーは、このプロパティをサポートしています。

    XForwardedForHostEnabled

    Boolean

    いいえ

    はい

    X-Forwarded-Host ヘッダーを使用して、ALB インスタンスのクライアントドメイン名を照会するかどうかを指定します。

    有効な値:

    • true

    • false (デフォルト)

    説明

    HTTP、HTTPS、および QUIC リスナーは、このプロパティをサポートしています。

    CaCertificates 構文

    "CaCertificates": [
  {
    "CertificateId": String // CA 証明書の ID
  }
]

    CaCertificates プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    CertificateId

    String

    いいえ

    はい

    CA 証明書の ID。

    なし。

    戻り値

    Fn::GetAtt

    ListenerId: リスナーの ID。

    LoadBalancerId: ALB インスタンスの ID。

    例

    YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  LoadBalancerId:
    Type: String
    Description: ALB インスタンスの ID。
    Default: lb-bp1iilcd9ujny84z8****
Resources:
  Listener:
    Type: ALIYUN::ALB::Listener
    Properties:
      ListenerPort: 80
      DefaultActions:
        - ForwardGroupConfig:
            ServerGroupTuples:
              - ServerGroupId: sgp-46ndzg2wz4v5mp****
          Type: ForwardGroup
      LoadBalancerId:
        Ref: LoadBalancerId
      ListenerProtocol: HTTP
Outputs:
  ListenerId:
    Description: リスナーの ID。
    Value:
      Fn::GetAtt:
        - Listener
        - ListenerId

    JSON 形式

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "LoadBalancerId": {
      "Type": "String",
      "Description": "ALB インスタンスの ID。",
      "Default": "lb-bp1iilcd9ujny84z8****"
    }
  },
  "Resources": {
    "Listener": {
      "Type": "ALIYUN::ALB::Listener",
      "Properties": {
        "ListenerPort": 80,
        "DefaultActions": [
          {
            "ForwardGroupConfig": {
              "ServerGroupTuples": [
                {
                  "ServerGroupId": "sgp-46ndzg2wz4v5mp****"
                }
              ]
            },
            "Type": "ForwardGroup"
          }
        ],
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        },
        "ListenerProtocol": "HTTP"
      }
    }
  },
  "Outputs": {
    "ListenerId": {
      "Description": "リスナーの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Listener",
          "ListenerId"
        ]
      }
    }
  }
}