Describe Listeners
elbv2_describe_listeners | R Documentation |
Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer¶
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.
Usage¶
Arguments¶
LoadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
ListenerArns
The Amazon Resource Names (ARN) of the listeners.
Marker
The marker for the next set of results. (You received this marker from a previous call.)
PageSize
The maximum number of results to return with this call.
Value¶
A list with the following syntax:
list(
Listeners = list(
list(
ListenerArn = "string",
LoadBalancerArn = "string",
Port = 123,
Protocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
Certificates = list(
list(
CertificateArn = "string",
IsDefault = TRUE|FALSE
)
),
SslPolicy = "string",
DefaultActions = list(
list(
Type = "forward"|"authenticate-oidc"|"authenticate-cognito"|"redirect"|"fixed-response",
TargetGroupArn = "string",
AuthenticateOidcConfig = list(
Issuer = "string",
AuthorizationEndpoint = "string",
TokenEndpoint = "string",
UserInfoEndpoint = "string",
ClientId = "string",
ClientSecret = "string",
SessionCookieName = "string",
Scope = "string",
SessionTimeout = 123,
AuthenticationRequestExtraParams = list(
"string"
),
OnUnauthenticatedRequest = "deny"|"allow"|"authenticate",
UseExistingClientSecret = TRUE|FALSE
),
AuthenticateCognitoConfig = list(
UserPoolArn = "string",
UserPoolClientId = "string",
UserPoolDomain = "string",
SessionCookieName = "string",
Scope = "string",
SessionTimeout = 123,
AuthenticationRequestExtraParams = list(
"string"
),
OnUnauthenticatedRequest = "deny"|"allow"|"authenticate"
),
Order = 123,
RedirectConfig = list(
Protocol = "string",
Port = "string",
Host = "string",
Path = "string",
Query = "string",
StatusCode = "HTTP_301"|"HTTP_302"
),
FixedResponseConfig = list(
MessageBody = "string",
StatusCode = "string",
ContentType = "string"
),
ForwardConfig = list(
TargetGroups = list(
list(
TargetGroupArn = "string",
Weight = 123
)
),
TargetGroupStickinessConfig = list(
Enabled = TRUE|FALSE,
DurationSeconds = 123
)
)
)
),
AlpnPolicy = list(
"string"
),
MutualAuthentication = list(
Mode = "string",
TrustStoreArn = "string",
IgnoreClientCertificateExpiry = TRUE|FALSE,
TrustStoreAssociationStatus = "active"|"removed"
)
)
),
NextMarker = "string"
)
Request syntax¶
svc$describe_listeners(
LoadBalancerArn = "string",
ListenerArns = list(
"string"
),
Marker = "string",
PageSize = 123
)