Skip to content

aws.elbv2.describe_listeners

Example SQL Queries

SELECT * FROM
aws.elbv2.describe_listeners;

Description

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.

Table Definition

Column NameColumn Data Type
listener_arns Input Column

The Amazon Resource Names (ARN) of the listeners.

VARCHAR[]
Show child fields
listener_arns[]
load_balancer_arn Input Column

The Amazon Resource Name (ARN) of the load balancer.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

alpn_policy

[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

VARCHAR[]
Show child fields
alpn_policy[]
certificates

[HTTPS or TLS listener] The default certificate for the listener.

STRUCT(
"certificate_arn" VARCHAR,
"is_default" BOOLEAN
)[]
Show child fields
certificates[]
Show child fields
certificates[].certificate_arn

The Amazon Resource Name (ARN) of the certificate.

certificates[].is_default

Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

default_actions

The default actions for the listener.

STRUCT(
"type" VARCHAR,
"target_group_arn" VARCHAR,
"authenticate_oidc_config" STRUCT(
"issuer" VARCHAR,
"authorization_endpoint" VARCHAR,
"token_endpoint" VARCHAR,
"user_info_endpoint" VARCHAR,
"client_id" VARCHAR,
"client_secret" VARCHAR,
"session_cookie_name" VARCHAR,
"scope" VARCHAR,
"session_timeout" BIGINT,
"authentication_request_extra_params" MAP(VARCHAR, VARCHAR),
"on_unauthenticated_request" VARCHAR,
"use_existing_client_secret" BOOLEAN
),
"authenticate_cognito_config" STRUCT(
"user_pool_arn" VARCHAR,
"user_pool_client_id" VARCHAR,
"user_pool_domain" VARCHAR,
"session_cookie_name" VARCHAR,
"scope" VARCHAR,
"session_timeout" BIGINT,
"authentication_request_extra_params" MAP(VARCHAR, VARCHAR),
"on_unauthenticated_request" VARCHAR
),
"order" BIGINT,
"redirect_config" STRUCT(
"protocol" VARCHAR,
"port" VARCHAR,
"host" VARCHAR,
"path" VARCHAR,
"query" VARCHAR,
"status_code" VARCHAR
),
"fixed_response_config" STRUCT(
"message_body" VARCHAR,
"status_code" VARCHAR,
"content_type" VARCHAR
),
"forward_config" STRUCT(
"target_groups" STRUCT(
"target_group_arn" VARCHAR,
"weight" BIGINT
)[],
"target_group_stickiness_config" STRUCT(
"enabled" BOOLEAN,
"duration_seconds" BIGINT
)
)
)[]
Show child fields
default_actions[]
Show child fields
default_actions[].authenticate_cognito_config

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Show child fields
default_actions[].authenticate_cognito_config.authentication_request_extra_params

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

default_actions[].authenticate_cognito_config.on_unauthenticated_request

The behavior if the user is not authenticated. The following are possible values:

  • deny - Return an HTTP 401 Unauthorized error.

  • allow - Allow the request to be forwarded to the target.

  • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

default_actions[].authenticate_cognito_config.scope

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

default_actions[].authenticate_cognito_config.session_cookie_name

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

default_actions[].authenticate_cognito_config.session_timeout

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

default_actions[].authenticate_cognito_config.user_pool_arn

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

default_actions[].authenticate_cognito_config.user_pool_client_id

The ID of the Amazon Cognito user pool client.

default_actions[].authenticate_cognito_config.user_pool_domain

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

default_actions[].authenticate_oidc_config

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Show child fields
default_actions[].authenticate_oidc_config.authentication_request_extra_params

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

default_actions[].authenticate_oidc_config.authorization_endpoint

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

default_actions[].authenticate_oidc_config.client_id

The OAuth 2.0 client identifier.

default_actions[].authenticate_oidc_config.client_secret

The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

default_actions[].authenticate_oidc_config.issuer

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

default_actions[].authenticate_oidc_config.on_unauthenticated_request

The behavior if the user is not authenticated. The following are possible values:

  • deny - Return an HTTP 401 Unauthorized error.

  • allow - Allow the request to be forwarded to the target.

  • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

default_actions[].authenticate_oidc_config.scope

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

default_actions[].authenticate_oidc_config.session_cookie_name

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

default_actions[].authenticate_oidc_config.session_timeout

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

default_actions[].authenticate_oidc_config.token_endpoint

The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

default_actions[].authenticate_oidc_config.use_existing_client_secret

Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

default_actions[].authenticate_oidc_config.user_info_endpoint

The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

default_actions[].fixed_response_config

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Show child fields
default_actions[].fixed_response_config.content_type

The content type.

Valid Values: text/plain | text/css | text/html | application/javascript | application/json

default_actions[].fixed_response_config.message_body

The message.

default_actions[].fixed_response_config.status_code

The HTTP response code (2XX, 4XX, or 5XX).

default_actions[].forward_config

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Show child fields
default_actions[].forward_config.target_group_stickiness_config

The target group stickiness for the rule.

Show child fields
default_actions[].forward_config.target_group_stickiness_config.duration_seconds

The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

default_actions[].forward_config.target_group_stickiness_config.enabled

Indicates whether target group stickiness is enabled.

default_actions[].forward_config.target_groups[]
Show child fields
default_actions[].forward_config.target_groups[].target_group_arn

The Amazon Resource Name (ARN) of the target group.

default_actions[].forward_config.target_groups[].weight

The weight. The range is 0 to 999.

default_actions[].order

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

default_actions[].redirect_config

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Show child fields
default_actions[].redirect_config.host

The hostname. This component is not percent-encoded. The hostname can contain #{host}.

default_actions[].redirect_config.path

The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.

default_actions[].redirect_config.port

The port. You can specify a value from 1 to 65535 or #{port}.

default_actions[].redirect_config.protocol

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

default_actions[].redirect_config.query

The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.

default_actions[].redirect_config.status_code

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

default_actions[].target_group_arn

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

default_actions[].type

The type of action.

listener_arn

The Amazon Resource Name (ARN) of the listener.

VARCHAR
mutual_authentication

The mutual authentication configuration information.

STRUCT(
"mode" VARCHAR,
"trust_store_arn" VARCHAR,
"ignore_client_certificate_expiry" BOOLEAN,
"trust_store_association_status" VARCHAR
)
Show child fields
mutual_authentication.ignore_client_certificate_expiry

Indicates whether expired client certificates are ignored.

mutual_authentication.mode

The client certificate handling method. Options are off, passthrough or verify. The default value is off.

mutual_authentication.trust_store_arn

The Amazon Resource Name (ARN) of the trust store.

mutual_authentication.trust_store_association_status

Indicates a shared trust stores association status.

port

The port on which the load balancer is listening.

BIGINT
protocol

The protocol for connections from clients to the load balancer.

VARCHAR
ssl_policy

[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.

VARCHAR