メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::ElasticLoadBalancingV2::Listener

AWS::ElasticLoadBalancingV2::Listener リソースは、Elastic Load Balancing Application Load Balancer またはネットワークロードバランサーのリスナーを作成します。リスナーは接続リクエストを確認し、1 つまたは複数のターゲットグループへそのリクエストを転送します。 詳細については、Elastic Load Balancing ユーザーガイドの「ご利用開始にあたって」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::ElasticLoadBalancingV2::Listener", "Properties" : { "Certificates" : [ Certificates, ... ], "DefaultActions" : [ DefaultActions, ... ], "LoadBalancerArn" : String, "Port" : Integer, "Protocol" : String, "SslPolicy" : String } }

YAML

Copy
Type: "AWS::ElasticLoadBalancingV2::Listener" Properties: Certificates: - Certificates DefaultActions: - DefaultActions LoadBalancerArn: String Port: Integer Protocol: String SslPolicy: String

プロパティ

Certificates

リスナーの SSL サーバー証明書。 証明書を使用すると、ロードバランサーと HTTPS セッションを開始するクライアント間のトラフィック、そしてロードバランサーとターゲット間のトラフィックを暗号化できます。

Required: Conditional。Protocol プロパティに HTTPS を指定すると、証明書を指定します。

Elastic Load Balancing リスナー証明書Type: リスト

更新に伴う要件: 中断はありません。

DefaultActions

受信したリクエストを処理した場合に、リスナーが実行するデフォルトのアクション。

Required: Yes

Elastic Load Balancing Listener DefaultActionsType: リスト

更新に伴う要件: 中断はありません。

LoadBalancerArn

リスナーに関連付けるロードバランサーの Amazon Resource Name (ARN)。

Required: Yes

Type: String

更新に伴う要件: 置換

Port

リスナーがリクエストを交信するポート。

有効な値については、「Elastic Load Balancing API リファレンスバージョン 2015-12-01」の [CreateListener アクションの Port パラメーター] を参照してください。

Required: Yes

Type: Integer

更新に伴う要件: 中断はありません。

Protocol

リスナーにリクエストを送信するためにクライアントが使用するべきプロトコル。

有効な値については、「Elastic Load Balancing API リファレンスバージョン 2015-12-01」の [CreateListener アクションの Protocol パラメーター] を参照してください。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

SslPolicy

ロードバランサーがサポートする暗号やプロトコルを定義するセキュリティポリシー。

Required: No

Type: String

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 のようなリスナーの ARN が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、myLoadBalancer リソースのリスナーを作成します。 Listener のデフォルトのアクションにより、myTargetGroup ターゲットグループにリクエストを転送します。

JSON

Copy
"Listener": { "Type": "AWS::ElasticLoadBalancingV2::Listener", "Properties": { "DefaultActions": [{ "Type": "forward", "TargetGroupArn": { "Ref": "myTargetGroup" } }], "LoadBalancerArn": { "Ref": "myLoadBalancer" }, "Port": "8000", "Protocol": "HTTP" } }

YAML

Copy
Listener: Type: AWS::ElasticLoadBalancingV2::Listener Properties: DefaultActions: - Type: forward TargetGroupArn: Ref: myTargetGroup LoadBalancerArn: Ref: myLoadBalancer Port: '8000' Protocol: HTTP

このページの内容: