すべてのプロダクト
Search
ドキュメントセンター

Container Service for Kubernetes:ALB Ingress GlobalConfigurationディクショナリ

最終更新日:Nov 14, 2024

AlbConfigを使用して、Application Load Balancer (ALB) インスタンスの設定を定義できます。 このトピックでは、ALB Ingressでサポートされているアノテーションについて説明します。 このトピックでは、AlbConfigフィールドとこれらのフィールドの使用方法についても説明します。

ALB Ingressesがサポートする注釈

ビジネス要件に基づいてALB Ingressに注釈を追加できます。

ヘルスチェック

注釈

説明

alb.ingress.kubernetes.io/healthcheck-enabled

バックエンドサーバーグループのヘルスチェック機能を有効にするかどうかを指定します。 詳細については、「ヘルスチェックの設定」をご参照ください。

  • true: ヘルスチェック機能を有効にします。

  • false: ヘルスチェック機能を無効にします。

デフォルト値: "false"

alb.ingress.kubernetes.io/healthcheck-path

ヘルスチェックに使用されるURL。

デフォルト値: /

alb.ingress.kubernetes.io/healthcheck-protocol

ヘルスチェックのプロトコル。

  • HTTP: ヘルスチェックはHTTPを使用して実行されます。 HEADまたはGETリクエストはバックエンドサーバーに送信され、ヘルスステータスが確認されます。

  • HTTPS: ヘルスチェックはHTTPSを使用して実行されます。 HEADまたはGETリクエストはバックエンドサーバーに送信され、ヘルスステータスが確認されます。

  • TCP: ヘルスチェックはTCPを使用して実行されます。 SYNパケットがバックエンドサーバーに送信され、バックエンドサーバーのポートがリクエストを受信できるかどうかが確認されます。

  • GRPC: ヘルスチェックはgRPCを使用して実行されます。 POSTまたはGETリクエストはバックエンドサーバーに送信され、ヘルスステータスが確認されます。

デフォルト値: HTTP

alb.ingress.kubernetes.io/healthcheck-httpversion

HTTPプロトコルのバージョン。 このパラメーターは、healthcheck-protocolHTTPまたはHTTPSに設定されている場合にのみ有効になります。

  • HTTP1.0

  • HTTP1.1

デフォルト値: HTTP1.1

alb.ingress.kubernetes.io/healthcheck-method

ヘルスチェックの方法。

  • ヘッド

  • POST

  • GET

デフォルト値: HEAD

重要

healthcheck-protocolGRPCに設定した場合、このパラメーターをPOSTまたはGETに設定する必要があります。

alb.ingress.kubernetes.io/healthcheck-httpcode

ヘルスチェック用に返されるステータスコード。 バックエンドサーバーは、ヘルスチェックリクエストが成功し、指定されたステータスコードのいずれかが返された場合にのみ正常と見なされます。

次の1つ以上のステータスコードを選択し、複数のステータスコードをコンマ (,) で区切ることができます。

  • http_2xx

  • http_3xx

  • http_4xx

  • http_5xx

デフォルト値は、 http_2xx です。

alb.ingress.kubernetes.io/healthcheck-code

ヘルスチェック用に返されるステータスコード。 バックエンドサーバーは、ヘルスチェックリクエストが成功し、指定されたステータスコードのいずれかが返された場合にのみ正常と見なされます。

このパラメーターとhealthcheck-httpcodeの両方を指定した場合、このパラメーターが優先されます。

このパラメーターの値は、healthcheck-protocolで指定された値によって異なります。

  • HTTPまたはHTTPS: 次のステータスコードの1つ以上を選択し、複数のステータスコードをコンマ (,) で区切ることができます。

    • http_2xx

    • http_3xx

    • http_4xx

    • http_5xx

    デフォルト値は、 http_2xx です。

  • GRPC:

    有効な値: 0 ~ 99。

    デフォルト値:0

    値の範囲がサポートされています。 最大20個の値の範囲を入力でき、各範囲をコンマ (,) で区切る必要があります。

alb.ingress.kubernetes.io/healthcheck-timeout-seconds

ヘルスチェックのタイムアウト時間 (秒) 。

有効な値:1 から 300。

デフォルト値: 5

alb.ingress.kubernetes.io/healthcheck-interval-seconds

ヘルスチェックの間隔 (秒) 。

有効値:1 〜 50 。

デフォルト値: 2

alb.ingress.kubernetes.io/healthy-threshold-count

正常と見なされるまでに、サーバーが連続してヘルスチェックに合格する必要がある回数。

設定可能な値は 1 から 100 です。

デフォルト値: 3

alb.ingress.kubernetes.io/unhealthy-threshold-count

異常と見なされるまでに、サーバーが連続してヘルスチェックに失敗する必要がある回数。

設定可能な値は 1 から 100 です。

デフォルト値: 3

alb.ingress.kubernetes.io/healthcheck-connect-port

ヘルスチェックに使用されるポート。

デフォルト値:0

説明

0は、バックエンドサーバーのポートがヘルスチェックに使用されていることを示します。

リダイレクト

注釈

説明

alb.ingress.kubernetes.io/ssl-リダイレクト

HTTPリクエストの308のステータスコードを返し、ポート443のHTTPSリスナーにリダイレクトするかどうかを指定します。 リダイレクトの設定方法の詳細については、「HTTPリクエストをHTTPSにリダイレクトする」をご参照ください。

  • true: HTTPSリクエストにリダイレクトします。

  • false: HTTPSリクエストにリダイレクトしません。

デフォルト値: "false"

バックエンドサーバープロトコル

注釈

説明

alb.ingress.kubernetes.io/backend-protocol

バックエンドサーバーグループによって使用されるプロトコル。 詳細については、「HTTPSまたはgRPCプロトコルの設定」をご参照ください。

  • http

  • https

  • grpc

デフォルト値: http

説明

リスナーでサポートされるバックエンドサーバープロトコルは、リスナータイプによって異なります。

  • HTTPリスナーはHTTPとHTTPSをサポートしています。

  • HTTPSリスナーは、HTTP、HTTPS、およびgRPCをサポートします。

  • QUICリスナーはHTTPをサポートしています。

書き換え

注釈

説明

alb.ingress.kubernetes.io /書き換え対象

リクエストでパスを上書きするパス。 詳細は、「書き換えルールの設定」をご参照ください。

リスナー

注釈

説明

alb.ingress.kubernetes.io/listen-ports

ALB Ingressに関連付けられたリスナーのリスニングポートとプロトコル。 詳細については、「カスタムリスニングポートの設定」をご参照ください。

例:

  • '[{"HTTP": 80}]': ポート80でリッスンするHTTPリスナーを関連付けます。

  • '[{"HTTPS": 443}]': ポート443でリッスンするHTTPSリスナーを関連付けます。

  • '[{"QUIC": 443}]': ポート443でリッスンするQUICリスナーを関連付けます。

  • '[{"HTTP": 80}, {"HTTPS": 443}]': ポート80でリッスンするHTTPリスナーとポート443でリッスンするHTTPSリスナーを関連付けます。

  • '[{"HTTPS": 443}, {"QUIC": 443}]': ポート443でリッスンするHTTPSリスナーとポート443でリッスンするQUICリスナーを関連付けます。

スロースタート

注釈

説明

alb.ingress.kubernetes.io/slow-start-enabled

スロースタートモードを有効にするかどうかを指定します。 スロースタートモードを有効にすると、ALB Ingressはサービスバックエンドに追加された新しいポッドにトラフィックを徐々に分配し、ポッドの起動による突然のCPUとメモリのスパイクを回避します。 スロースタート設定の詳細については、「バックエンドスロースタート」をご参照ください。

  • true: スロースタートモードを有効にします。

  • false: スロースタートモードを無効にします。

デフォルトでは、このモードは無効になっています。

alb.ingress.kubernetes.io/slow-start-duration

スロースタートが徐々にトラフィックを増やすのにかかる時間。 持続時間が長いほど、トラフィックの増加は遅くなります。 単位は秒です。

有効な値: 30 ~ 900

既定値: 30.

優先度

注釈

説明

alb.ingress.kubernetes.io /オーダー

転送ルールの優先度。 数字が小さいほど、優先度が高くなります。 詳細については、「転送ルールの優先度の設定」をご参照ください。

有効な値: 1 ~ 1000

デフォルト値: 10

カナリア

注釈

説明

alb.ingress.kubernetes.io /カナリア

リクエストをカナリアにルーティングするかどうかを指定します。 詳細については、「注釈を使用してカナリアリリースを実行する」をご参照ください。

  • true: リクエストをカナリアにルーティングします。

  • false: リクエストをカナリアにルーティングしません。

デフォルト値: "false"

alb.ingress.kubernetes.io/canary-by-header

カナリアにルーティングされるリクエストのヘッダー。

alb.ingress.kubernetes.io/canary-by-header-value

カナリアにルーティングされるリクエストのヘッダーの値。

alb.ingress.kubernetes.io/canary-by-cookie

カナリアにルーティングされるリクエストのcookie。

セッション持続性

注釈

説明

alb.ingress.kubernetes.io /スティッキーセッション

セッションの継続時間を適用するかどうかを設定します。 詳細については、「注釈を使用したセッション永続性の設定」をご参照ください。

  • true: セッション維持を有効にします。

  • false: セッション維持を無効にします。

デフォルト値: "false"

alb.ingress.kubernetes.io /スティッキーセッションタイプ

Cookieを処理するために使用されるメソッド。

  • Insert: クッキーを挿入します。 クライアントの最初の訪問中に、ALBインスタンスは応答にcookieを追加します。

  • サーバー: Cookieを書き換えます。 ALBインスタンスは、ユーザー定義のcookieに基づいてcookieを書き換えます。

デフォルト値: Insert

alb.ingress.kubernetes.io/cookie-timeout

セッション永続化タイムアウト時間 (秒) 。

有効な値: 1 ~ 86400

デフォルト値: 1000

接続ドレイン

注釈

説明

alb.ingress.kubernetes.io/connection-drain-enabled

接続ドレインを有効にするかどうかを指定します。 接続のドレインが有効になっている場合、ALB Ingressは、バックエンドポッドが終了状態になったとき、またはヘルスチェックが失敗したときの一定期間、通常のトラフィックを維持します。 接続はタイムアウト期間に達した後にのみ終了します。これにより、バックエンドの突然の削除によるサービスへの影響を軽減できます。 接続ドレインの仕組みの詳細については、「接続ドレイン」をご参照ください。

  • true: 接続のドレインを有効にします。

  • false: 接続のドレインを無効にします。

デフォルト値: "false"

alb.ingress.kubernetes.io/connection-drain-timeout

接続ドレインのタイムアウト期間。 単位は秒です。

有効な値: 0 ~ 900

デフォルト値: 300

負荷分散

注釈

説明

alb.ingress.kubernetes.io/backend-scheduler

バックエンドサーバーグループの負荷分散アルゴリズム。 詳細については、「バックエンドサーバーグループの負荷分散アルゴリズムの指定」をご参照ください。

  • wrr: 重み付きラウンドロビン。 重みの大きいバックエンドサーバーは、重みの小さいバックエンドサーバーよりも多くのリクエストを受け取ります。

  • wlc: 重み付き最小接続。 複数のバックエンドサーバーの重みが同じ場合、リクエストは接続が最も少ないバックエンドサーバーに転送されます。

  • sch: ソースIPハッシュ。 同じ送信元IPアドレスからのリクエストは、同じバックエンドサーバーに配信されます。

  • uch: URLハッシュ。 同じURL宛てのリクエストは、同じバックエンドサーバーに配信されます。

デフォルト値: wrr

alb.ingress.kubernetes.io/backend-scheduler-uch-value

負荷分散アルゴリズムがuchの場合に使用できるURLハッシュパラメータ。

クロスオリジンリソース共有 (CORS)

注釈

説明

alb.ingress.kubernetes.io/enable-cors

CORSを有効にするかどうかを指定します。 詳細については、「CORS の設定」をご参照ください。

  • true: CORSを有効にします。

  • false: CORSを無効にします。

デフォルト値: "false"

alb.ingress.kubernetes.io/cors-allow-origin

クロスドメインリクエストを許可するオリジン。

デフォルト値: *

alb.ingress.kubernetes.io/cors-exposure-headers

公開できるヘッダー。

alb.ingress.kubernetes.io/cors-allow-methods

許可されているクロスドメイン要求のメソッド。

次の方法の1つ以上を選択できます。

  • GET

  • POST

  • PUT

  • 削除

  • ヘッド

  • OPTIONS

  • パッチ

デフォルト値: "GET, PUT, POST, DELETE, PATCH, OPTIONS"

alb.ingress.kubernetes.io/cors-allow-credentials

リクエストで資格情報を保持するかどうかを指定します。

  • true: リクエストで資格情報を保持します。

  • false: リクエストで資格情報を保持しません。

デフォルト値: true

alb.ingress.kubernetes.io/cors-max-age

ブラウザでのプリフライト要求の最大キャッシュ時間。 単位は秒です。

有効値: -1 ~ 172800

デフォルト値: 172800

説明

-1は、キャッシュ時間が制限されていないことを示します。

alb.ingress.kubernetes.io/cors-allow-headers

許可されているクロスドメイン要求のヘッダー。

デフォルト値: 「DNT、X-CustomHeader、Keep-Alive、User-Agent、X-Requested-With、If-Modified-Since、Cache-Control、Content-Type、Authorization」

カスタム転送

注釈

説明

alb.ingress.kubernetes.io/actions.{svcName}

カスタム転送アクション。 詳細については、「ALB Ingressのルーティングルールのカスタマイズ」をご参照ください。

alb.ingress.kubernetes.io/conditions.{svcName}

カスタム転送条件。

alb.ingress.kubernetes.io/rule-direction。{svcName}

カスタム転送方向。

  • リクエスト: ルールはリクエストに対して有効になります。

  • 応答: ルールは応答に対して有効になります。

デフォルト値: Request

その他

注釈

説明

alb.ingress.kubernetes.io/backend-keepalive

永続的なTCP接続を有効にするかどうかを指定します。 詳細については、「永続TCP接続の設定」をご参照ください。

デフォルト値: "false"

alb.ingress.kubernetes.io/traffic-limit-qps

QPSスロットル。

設定可能な値は1 から 100です。

alb.ingress.kubernetes.io/use-regex

パスフィールドで正規表現を使用できるかどうかを指定します。 このアノテーションは、パスタイプがPrefixの場合にのみ有効です。

デフォルト値: "false"

AlbConfigフィールド

AlbConfigは、ALBインスタンスとそのリスナーを記述するために使用されるCustomResourceDefinition (CRD) です。 次の表では、関連するフィールドについて説明します。

Albconfig

項目

タイプ

説明

apiVersion

固定値

オブジェクトのAPIバージョン。

値をalibabacloud.com/v1に設定します。

種類

固定値

Kindは、オブジェクトに対応するRESTリソースを示します。

値をAlbConfigに設定します。

metadata

ObjectMeta

オブジェクトのメタデータ。

詳細については、「メタデータ」をご参照ください。

スペック

AlbConfigSpec

ALBインスタンスとそのリスナーの属性を記述するために使用されるパラメーターのリスト。

status

AlbConfigStatus

調整後、ALBインスタンスの状態がstatusフィールドに書き込まれます。 フィールドの値は、ALBインスタンスの現在の状態を示します。

AlbConfigSpec

項目

タイプ

説明

config

LoadBalancerSpec

ALBインスタンスの属性。

リスナー

ListenerSpec[]

ALBインスタンスのリスナーの属性。

LoadBalancerSpec

項目

タイプ

説明

id

String

ALBインスタンスのID。 インスタンスIDが指定されている場合、ALBインスタンスは再利用できます。 このフィールドを空のままにすると、ALB IngressコントローラーはALBインスタンスを作成します。 ALBインスタンスを作成または再利用する方法の詳細については、「AlbConfigの作成」をご参照ください。

デフォルト値: ""

name

String

ALBインスタンスの名前。

デフォルト値: k8s-{namespace}-{name}-{hashCode} 形式の名前が自動的に生成されます。

addressAllocatedMode

enum

ALBインスタンスのIPモード。

  • 動的: ALBインスタンスには、各ゾーンで少なくとも1つのIPアドレスが割り当てられています。 IPアドレスの数は、より多くのリクエストを受信すると自動的に増加します。 この動的モードは、最大100万個のQPSをサポートします。

  • 修正済み: ALBインスタンスには、各ゾーンで1つのIPアドレスのみが割り当てられ、IPアドレスは静的です。 固定モードは最大100,000 QPSをサポートします。

デフォルト値: Dynamic

addressType

enum

ALBインスタンスのIPv4 CIDRブロックのネットワークタイプ。

  • インターネット: インターネット。 ALBインスタンスにはパブリックドメイン名が割り当てられています。

  • イントラネット: 内部ネットワーク。

デフォルト値: Internet

ipv6AddressType

enum

ALBインスタンスのIPv6 CIDRブロックのネットワークタイプ。 ネットワークタイプは、ALBインスタンスのIPv4 CIDRブロックとは異なる場合があります。

  • インターネット: インターネット。 ALBインスタンスにはパブリックドメイン名が割り当てられています。

  • イントラネット: 内部ネットワーク。

デフォルト値: イントラネット

addressIpVersion

enum

ALBインスタンスがデュアルスタックをサポートするかどうかを指定します。

  • IPv4: IPv4のみがサポートされています。

  • DualStack: IPv4とIPv6がサポートされています。

デフォルト値: IPv4

resourceGroupId

String

ALBインスタンスが属するリソースグループのID。

デフォルト値: ""

エディション

enum

ALBインスタンスのエディション。 このパラメーターは、再利用モードでは変更できません。

デフォルト値: Standard

deletionProtectionEnabled

bool

予約済みフィールド。 このフィールドは変更しないでください。

forceOverride

bool

再利用モードでALBインスタンスの属性を強制的に上書きするかどうかを指定します。

  • true: 再利用モードでALBインスタンスの属性を強制的に上書きします。

  • false: 再利用モードでALBインスタンスの属性を強制的に上書きしません。

  • null: 再利用モードでALBインスタンスの属性を強制的に上書きしません。

デフォルト値: "false"

listenerForceOverride

bool

再利用モードでリスナーの属性を強制的に上書きするかどうかを指定します。

  • true: 再利用モードでALBインスタンスの属性を強制的に上書きします。

  • false: 再利用モードでALBインスタンスの属性を強制的に上書きしません。

  • null: 再利用モードのリスナーの属性を強制的に上書きしません。

デフォルト値: null

zoneMappings

ZoneMapping[]

ゾーンとEIP (elastic IPアドレス) の設定。

accessLogConfig

AccessLogConfig

ログ収集の設定。

billingConfig

BillingConfig

課金方法です。

modificationProtectionConfig

ModificationProtectionConfig

構成保護の設定。

tags

タグ []

ALBインスタンスのラベル。

ZoneMapping

項目

タイプ

説明

vSwitchId

String

vSwitch ID。 このフィールドは必須です。

デフォルト値: ""

zoneId

String

vSwitchのゾーン。

デフォルト値: ""

allocationId

String

EIP の ID 。

デフォルト値: ""

eipType

String

予約済みフィールド。 このフィールドは変更しないでください。

AccessLogConfig

項目

タイプ

説明

logProject

String

Simple Log Service (SLS) プロジェクトの名前。

デフォルト値: ""

logStore

String

SLS Logstoreの名前。alb_ で始まる必要があります。 SLS Logstoreは、存在しない場合は自動的に作成されます。 詳細については、「Simple Log Serviceによるアクセスログの収集」をご参照ください。

デフォルト値: ""

BillingConfig

項目

タイプ

説明

internetBandwidth

int

予約済みフィールド。 このフィールドは変更しないでください。

internetChargeType

String

予約済みフィールド。 このフィールドは変更しないでください。

payType

enum

予約済みフィールド。 このフィールドは変更しないでください。

bandWidthPackageId

string[]

関連付けられているインターネット共有帯域幅インスタンスのID。 インターネット共有帯域幅インスタンスの関連付けを解除することはできません。

デフォルト値: ""

ModificationProtectionConfig

項目

タイプ

説明

理由

String

予約済みフィールド。

status

String

予約済みフィールド。

タグ

項目

タイプ

説明

キー

String

ラベルのキー。

デフォルト値: ""

value

String

ラベルの値。

デフォルト値: ""

ListenerSpec

項目

タイプ

説明

gzipEnabled

bool

データ圧縮を有効にするかどうかを指定します。 詳細については、「データ圧縮の設定」をご参照ください。

  • true: データ圧縮を有効にします。

  • false: データ圧縮を無効にします。

  • null: データ圧縮を有効にします。

デフォルト値: null

http2Enabled

bool

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

  • true: HTTP/2を有効にします。

  • false: HTTP/2を無効にします。

  • null: HTTP/2を有効にします。

デフォルト値: null

port

int

リスニングポートです。 このフィールドは必須です。

デフォルト値:0

protocol

enum

リスニングプロトコル。 このフィールドは必須です。

  • HTTP

  • HTTPS

  • QUIC

securityPolicyId

String

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

デフォルト値: ""

idleTimeout

int

アイドル接続のタイムアウト期間 (秒単位) 。

デフォルト値: 15

説明

値0は、デフォルト値が使用されることを示します。

loadBalancerId

String

予約済みフィールド。 このフィールドは変更しないでください。

説明

String

リスナーの名前を示します。

デフォルトでは、ingress-auto-listener-{port} 形式の名前が自動的に生成されます。

caEnabled

bool

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

  • true: 相互認証を有効にします。

  • false: 相互認証を無効にします。

デフォルト値: "false"

requestTimeout

int

リクエストのタイムアウト時間 (秒) 。

デフォルト値: 60

quicConfig

QuicConfig

クイックリスナーの設定。

defaultActions

アクション []

予約済みフィールド。 このフィールドは変更しないでください。

caCertificates

証明書 []

リスナーのルートCA証明書。

証明書

証明書 []

リスナーのサーバー証明書。

xForwardedForConfig

XForwardedForConfig

XForwardヘッダーの設定。

logConfig

LogConfig

リスナーログの設定。

aclConfig

AclConfig

アクセス制御設定。

QuicConfig

項目

タイプ

説明

quicUpgradeEnabled

bool

QUICアップグレードを有効にするかどうかを指定します。 QUICリスナーとHTTPSリスナーの両方を使用するシナリオでは、quicUpgradeEnabledフィールドを設定して、QUICリスナーをHTTPSリスナーに関連付けるか、QUICリスナーをHTTPSリスナーから分離します。 詳細については、「QUICリスナーを使用したHTTP/3プロトコルのサポート」をご参照ください。

  • true: QUICアップグレードを有効にします。 QUICリスナーはHTTPSリスナーに関連付けられています。

  • false: QUICアップグレードを無効にします。 QUICリスナーはHTTPSリスナーとの関連付けが解除されます。

デフォルト値: "false"

quicListenerId

String

QUICリスナーに関連付けられているHTTPSリスナー。

デフォルト値: ""

証明書

項目

タイプ

説明

IsDefault

bool

証明書がデフォルトの証明書かどうかを指定します。 詳細については、「暗号化通信のHTTPS証明書の設定」をご参照ください。

  • true: 証明書はデフォルトの証明書です。

  • false: 証明書はデフォルトの証明書ではありません。

デフォルト値: "false"

重要

デフォルト証明書は1つだけ指定できます。

CertificateId

String

証明書の ID 。

デフォルト値: ""

XForwardedForConfig

項目

タイプ

説明

XForwardedForClientCertSubjectDNEnabled

bool

X-Forwarded-Clientcert-subjectdnヘッダーフィールドをALBインスタンスによって配布されるHTTPリクエストに追加して、クライアント証明書の所有者に関する情報を伝達するかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForProtoEnabled

bool

ALBインスタンスによって配信されるHTTPリクエストにX-Forwarded-Protoヘッダーフィールドを追加して、ALBインスタンスのリスニングプロトコルに関する情報を伝達するかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForClientCertIssuerDNEnabled

bool

X-Forwarded-Clientcert-issuerdnヘッダーフィールドをALBインスタンスによって配布されるHTTPリクエストに追加して、クライアント証明書の発行者に関する情報を伝達するかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForSLBIdEnabled

bool

X-Forwarded-For-SLB-IDヘッダーフィールドを、ALBインスタンスIDを運ぶためにALBインスタンスによって配布されるHTTPリクエストに追加するかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForClientSrcPortEnabled

bool

クライアントが使用するポートに関する情報を伝えるために、ALBインスタンスによって配信されるHTTPリクエストにX-Forwarded-Client-Portヘッダーフィールドを追加するかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForClientCertFingerprintEnabled

bool

クライアント証明書のフィンガープリントに関する情報を伝えるために、ALBインスタンスによって配布されるHTTPリクエストにX-Forwarded-Clientcert-fingerprintヘッダーフィールドを追加するかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForEnabled

bool

ALBインスタンスによって配信されるHTTPリクエストにX-Forwarded-Forヘッダーフィールドを追加してクライアントIPアドレスを伝達するかどうかを指定します。 このパラメーターをfalseに設定することはできません。

XForwardedForSLBPortEnabled

bool

ALBインスタンスによって配信されるHTTPリクエストにX-Forwarded-Portヘッダーフィールドを追加して、ALBインスタンスのリスニングポートに関する情報を伝達するかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForClientCertClientVerifyEnabled

bool

X-Forwarded-Clientcert-clientverifyヘッダーフィールドをALBインスタンスによって配布されたHTTPリクエストに追加して、クライアント証明書の検証結果を伝えるかどうかを指定します。

  • true: ヘッダーフィールドを追加します。

  • false: ヘッダーフィールドは追加されません。

デフォルト値: "false"

XForwardedForClientCertSubjectDNAlias

String

カスタムフィールド名。 このフィールドを指定すると、XForwardedForClientCertSubjectDNEnabledで追加されたX-Forwarded-Clientcert-subjectdnヘッダーフィールドの名前が指定された名前に置き換えられます。

このフィールドは、XForwardedForClientCertSubjectDNEnabledtrueに設定されている場合にのみ有効になります。

デフォルト値: ""

XForwardedForClientCertClientVerifyAlias

String

カスタムフィールド名。 このフィールドを指定すると、XForwardedForClientCertClientVerifyEnabledで追加されたX-Forwarded-Clientcert-clientverifyヘッダーフィールドの名前が指定された名前に置き換えられます。

このフィールドは、XForwardedForClientCertClientVerifyEnabledtrueに設定されている場合にのみ有効になります。

デフォルト値: ""

XForwardedForClientCertIssuerDNAlias

String

カスタムフィールド名。 このフィールドを指定すると、XForwardedForClientCertIssuerDNEnabledで追加されたX-Forwarded-Clientcert-issuerdnヘッダーフィールドの名前が指定された名前に置き換えられます。

このフィールドは、XForwardedForClientCertIssuerDNEnabledtrueに設定されている場合にのみ有効になります。

デフォルト値: ""

XForwardedForClientCertFingerprintAlias

String

カスタムフィールド名。 このフィールドを指定すると、XForwardedForClientCertFingerprintEnabledによって追加されたX-Forwarded-Clientcert-fingerprintヘッダーフィールドの名前が指定された名前に置き換えられます。

このフィールドは、XForwardedForClientCertFingerprintEnabledtrueに設定されている場合にのみ有効になります。

デフォルト値: ""

XForwardedForClientSourceIpsEnabled

bool

ALBインスタンスがX-Forwarded-ForヘッダーからクライアントIPアドレスを取得できるようにするかどうかを指定します。

  • true: 許可されます。 この場合、XForwardedForClientSourceIpsTrustedパラメーターは有効な形式で設定する必要があります。

  • false: 許可されていません。

デフォルト値: "false"

XForwardedForClientSourceIpsTrusted

String

信頼できるプロキシIPアドレスを指定します。

有効なIPアドレスまたはCIDRブロックを入力します。 複数の値をセミコロン (;) で区切ります。 これは、XForwardedForClientSourceIpsEnabledがtrueに設定されている場合にのみ有効です。

  • 信頼済みIPアドレスリストを0.0.0.0/0に設定します。ALBインスタンスは、X-Forwarded-Forヘッダーの左端のIPアドレスを取得します。 IPアドレスは送信元クライアントのIPアドレスです。

  • 信頼済みIPアドレスリストをproxy1 IP; proxy2 IP,.. の形式で設定します。ALBインスタンスは、X-Forwarded-ForヘッダーのIPアドレスを、信頼済みIPアドレスリストと右から左に比較します。 信頼済みIPアドレスリストにない最初のIPアドレスは、送信元クライアントIPアドレスと見なされます。

サンプル値: 192.168.x.x;192.168.x.x/16

AclConfig

項目

タイプ

説明

aclName

String

AclEntryモードのネットワークACLの名前。 詳細については、「ネットワークACLの設定」をご参照ください。

デフォルト値: ""

aclType

enum

アクセス制御モード。

  • : ブラックリストモード。指定されたIPアドレスからのアクセスをブロックします。

  • White: 指定されたIPアドレスからのアクセスのみを許可するホワイトリストモード。

aclEntries

string[]

ネットワークACLルール。

デフォルト値: ""

重要

aclEntriesフィールドとaclIdフィールドは相互に排他的です。 詳細については、「ネットワークACLの設定」をご参照ください。

aclIds

string[]

既存のネットワークACLのIDのリスト。

デフォルト値: ""

LogConfig

項目

タイプ

説明

accessLogRecordCustomizedHeadersEnabled

bool

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

  • true: カスタムヘッダーを記録します。

  • false: カスタムヘッダーは記録されません。

デフォルト値: "false"

accessLogTracingConfig

AccessLogTracingConfig

Tracing Analysisの設定。 詳細については、「AlbConfigsを使用したXtraceに基づくTracing Analysisの有効化」をご参照ください。

AccessLogTracingConfig

項目

タイプ

説明

tracingEnabled

bool

Tracing Analysisを有効にするかどうかを指定します。

  • true: Tracing Analysisを有効にします。

  • false: Tracing Analysisを無効にします。

デフォルト値: "false"

tracingSample

int

Tracing Analysisのサンプリングレート。 単位: 0.01%

有効な値: 1 ~ 10000

tracingType

enum

Tracing Analysisのサンプリングアルゴリズム。

  • ジプキン

AlbConfigStatus

重要

AlbConfigStatusLoadBalancerStatusListenerStatus、およびAppliedCertificateフィールドは、ALB Ingressが状態を記録するために使用する予約済みフィールドです。 これらのフィールドは変更しないでください。

項目

出力

説明

loadBalancer

LoadBalancerStatus

予約済みフィールド。 このフィールドは変更しないでください。

ALBインスタンスのステータス。

LoadBalancerStatus

項目

出力

説明

dnsname

String

予約済みフィールド。 このフィールドは変更しないでください。

ALBインスタンスのDNSアドレス。

id

String

予約済みフィールド。 このフィールドは変更しないでください。

ALBインスタンスのID。

リスナー

ListenerStatus

予約済みフィールド。 このフィールドは変更しないでください。

ALBインスタンスのリスナー属性。

ListenerStatus

項目

出力

説明

portAndProtocol

String

予約済みフィールド。 このフィールドは変更しないでください。

リスナーが使用するポートとプロトコル。

証明書

AppliedCertificate

予約済みフィールド。 このフィールドは変更しないでください。

リスナーに関連付けられている証明書。

AppliedCertificate

項目

出力

説明

certificateId

String

予約済みフィールド。 このフィールドは変更しないでください。

証明書の ID 。

isDefault

bool

予約済みフィールド。 このフィールドは変更しないでください。

証明書がデフォルトの証明書かどうかを指定します。

関連ドキュメント