Skip to main content

listener

Gets an individual listener resource

Overview

Namelistener
TypeResource
Descriptionlistener
Idawscc.elasticloadbalancingv2.listener

Fields

NameDatatypeDescription
ssl_policystring[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.<br/> For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.
load_balancer_arnstringThe Amazon Resource Name (ARN) of the load balancer.
default_actionsarrayThe actions for the default rule. You cannot define a condition for a default rule.<br/> To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).
portintegerThe port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
certificatesarrayThe default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.<br/> To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).
protocolstringThe protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
listener_arnstring
alpn_policyarray[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
mutual_authenticationobjectThe mutual authentication configuration information.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
ssl_policy,
load_balancer_arn,
default_actions,
port,
certificates,
protocol,
listener_arn,
alpn_policy,
mutual_authentication
FROM awscc.elasticloadbalancingv2.listener
WHERE data__Identifier = '<ListenerArn>';

Permissions

To operate on the listener resource, the following permissions are required:

Delete

elasticloadbalancing:DeleteListener,
elasticloadbalancing:DescribeListeners

Read

elasticloadbalancing:DescribeListeners

Update

elasticloadbalancing:ModifyListener,
elasticloadbalancing:DescribeListeners,
cognito-idp:DescribeUserPoolClient