1. Packages
  2. AWS
  3. API Docs
  4. alb
  5. getListener
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

aws.alb.getListener

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

Note: aws.alb.Listener is known as aws.lb.Listener. The functionality is identical.

Provides information about a Load Balancer Listener.

This data source can prove useful when a module accepts an LB Listener as an input variable and needs to know the LB it is attached to, or other information specific to the listener in question.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const listenerArn = config.require("listenerArn");
const listener = aws.lb.getListener({
    arn: listenerArn,
});
// get listener from load_balancer_arn and port
const selected = aws.lb.getLoadBalancer({
    name: "default-public",
});
const selected443 = selected.then(selected => aws.lb.getListener({
    loadBalancerArn: selected.arn,
    port: 443,
}));
Copy
import pulumi
import pulumi_aws as aws

config = pulumi.Config()
listener_arn = config.require("listenerArn")
listener = aws.lb.get_listener(arn=listener_arn)
# get listener from load_balancer_arn and port
selected = aws.lb.get_load_balancer(name="default-public")
selected443 = aws.lb.get_listener(load_balancer_arn=selected.arn,
    port=443)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		listenerArn := cfg.Require("listenerArn")
		_, err := lb.LookupListener(ctx, &lb.LookupListenerArgs{
			Arn: pulumi.StringRef(listenerArn),
		}, nil)
		if err != nil {
			return err
		}
		// get listener from load_balancer_arn and port
		selected, err := lb.LookupLoadBalancer(ctx, &lb.LookupLoadBalancerArgs{
			Name: pulumi.StringRef("default-public"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = lb.LookupListener(ctx, &lb.LookupListenerArgs{
			LoadBalancerArn: pulumi.StringRef(selected.Arn),
			Port:            pulumi.IntRef(443),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var listenerArn = config.Require("listenerArn");
    var listener = Aws.LB.GetListener.Invoke(new()
    {
        Arn = listenerArn,
    });

    // get listener from load_balancer_arn and port
    var selected = Aws.LB.GetLoadBalancer.Invoke(new()
    {
        Name = "default-public",
    });

    var selected443 = Aws.LB.GetListener.Invoke(new()
    {
        LoadBalancerArn = selected.Apply(getLoadBalancerResult => getLoadBalancerResult.Arn),
        Port = 443,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.LbFunctions;
import com.pulumi.aws.lb.inputs.GetListenerArgs;
import com.pulumi.aws.lb.inputs.GetLoadBalancerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var listenerArn = config.get("listenerArn");
        final var listener = LbFunctions.getListener(GetListenerArgs.builder()
            .arn(listenerArn)
            .build());

        // get listener from load_balancer_arn and port
        final var selected = LbFunctions.getLoadBalancer(GetLoadBalancerArgs.builder()
            .name("default-public")
            .build());

        final var selected443 = LbFunctions.getListener(GetListenerArgs.builder()
            .loadBalancerArn(selected.arn())
            .port(443)
            .build());

    }
}
Copy
configuration:
  # get listener from listener arn
  listenerArn:
    type: string
variables:
  listener:
    fn::invoke:
      function: aws:lb:getListener
      arguments:
        arn: ${listenerArn}
  # get listener from load_balancer_arn and port
  selected:
    fn::invoke:
      function: aws:lb:getLoadBalancer
      arguments:
        name: default-public
  selected443:
    fn::invoke:
      function: aws:lb:getListener
      arguments:
        loadBalancerArn: ${selected.arn}
        port: 443
Copy

Using getListener

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getListener(args: GetListenerArgs, opts?: InvokeOptions): Promise<GetListenerResult>
function getListenerOutput(args: GetListenerOutputArgs, opts?: InvokeOptions): Output<GetListenerResult>
Copy
def get_listener(arn: Optional[str] = None,
                 load_balancer_arn: Optional[str] = None,
                 port: Optional[int] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetListenerResult
def get_listener_output(arn: Optional[pulumi.Input[str]] = None,
                 load_balancer_arn: Optional[pulumi.Input[str]] = None,
                 port: Optional[pulumi.Input[int]] = None,
                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetListenerResult]
Copy
func LookupListener(ctx *Context, args *LookupListenerArgs, opts ...InvokeOption) (*LookupListenerResult, error)
func LookupListenerOutput(ctx *Context, args *LookupListenerOutputArgs, opts ...InvokeOption) LookupListenerResultOutput
Copy

> Note: This function is named LookupListener in the Go SDK.

public static class GetListener 
{
    public static Task<GetListenerResult> InvokeAsync(GetListenerArgs args, InvokeOptions? opts = null)
    public static Output<GetListenerResult> Invoke(GetListenerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
public static Output<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:alb/getListener:getListener
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn string
ARN of the listener. Required if load_balancer_arn and port is not set.
LoadBalancerArn string
ARN of the load balancer. Required if arn is not set.
Port int
Port of the listener. Required if arn is not set.
Tags Dictionary<string, string>
Arn string
ARN of the listener. Required if load_balancer_arn and port is not set.
LoadBalancerArn string
ARN of the load balancer. Required if arn is not set.
Port int
Port of the listener. Required if arn is not set.
Tags map[string]string
arn String
ARN of the listener. Required if load_balancer_arn and port is not set.
loadBalancerArn String
ARN of the load balancer. Required if arn is not set.
port Integer
Port of the listener. Required if arn is not set.
tags Map<String,String>
arn string
ARN of the listener. Required if load_balancer_arn and port is not set.
loadBalancerArn string
ARN of the load balancer. Required if arn is not set.
port number
Port of the listener. Required if arn is not set.
tags {[key: string]: string}
arn str
ARN of the listener. Required if load_balancer_arn and port is not set.
load_balancer_arn str
ARN of the load balancer. Required if arn is not set.
port int
Port of the listener. Required if arn is not set.
tags Mapping[str, str]
arn String
ARN of the listener. Required if load_balancer_arn and port is not set.
loadBalancerArn String
ARN of the load balancer. Required if arn is not set.
port Number
Port of the listener. Required if arn is not set.
tags Map<String>

getListener Result

The following output properties are available:

AlpnPolicy string
Arn string
CertificateArn string
DefaultActions List<GetListenerDefaultAction>
Id string
The provider-assigned unique ID for this managed resource.
LoadBalancerArn string
MutualAuthentications List<GetListenerMutualAuthentication>
Port int
Protocol string
SslPolicy string
Tags Dictionary<string, string>
AlpnPolicy string
Arn string
CertificateArn string
DefaultActions []GetListenerDefaultAction
Id string
The provider-assigned unique ID for this managed resource.
LoadBalancerArn string
MutualAuthentications []GetListenerMutualAuthentication
Port int
Protocol string
SslPolicy string
Tags map[string]string
alpnPolicy String
arn String
certificateArn String
defaultActions List<GetListenerDefaultAction>
id String
The provider-assigned unique ID for this managed resource.
loadBalancerArn String
mutualAuthentications List<GetListenerMutualAuthentication>
port Integer
protocol String
sslPolicy String
tags Map<String,String>
alpnPolicy string
arn string
certificateArn string
defaultActions GetListenerDefaultAction[]
id string
The provider-assigned unique ID for this managed resource.
loadBalancerArn string
mutualAuthentications GetListenerMutualAuthentication[]
port number
protocol string
sslPolicy string
tags {[key: string]: string}
alpnPolicy String
arn String
certificateArn String
defaultActions List<Property Map>
id String
The provider-assigned unique ID for this managed resource.
loadBalancerArn String
mutualAuthentications List<Property Map>
port Number
protocol String
sslPolicy String
tags Map<String>

Supporting Types

GetListenerDefaultAction

AuthenticateCognitos This property is required. List<GetListenerDefaultActionAuthenticateCognito>
AuthenticateOidcs This property is required. List<GetListenerDefaultActionAuthenticateOidc>
FixedResponses This property is required. List<GetListenerDefaultActionFixedResponse>
Forwards This property is required. List<GetListenerDefaultActionForward>
Order This property is required. int
Redirects This property is required. List<GetListenerDefaultActionRedirect>
TargetGroupArn This property is required. string
Type This property is required. string
AuthenticateCognitos This property is required. []GetListenerDefaultActionAuthenticateCognito
AuthenticateOidcs This property is required. []GetListenerDefaultActionAuthenticateOidc
FixedResponses This property is required. []GetListenerDefaultActionFixedResponse
Forwards This property is required. []GetListenerDefaultActionForward
Order This property is required. int
Redirects This property is required. []GetListenerDefaultActionRedirect
TargetGroupArn This property is required. string
Type This property is required. string
authenticateCognitos This property is required. List<GetListenerDefaultActionAuthenticateCognito>
authenticateOidcs This property is required. List<GetListenerDefaultActionAuthenticateOidc>
fixedResponses This property is required. List<GetListenerDefaultActionFixedResponse>
forwards This property is required. List<GetListenerDefaultActionForward>
order This property is required. Integer
redirects This property is required. List<GetListenerDefaultActionRedirect>
targetGroupArn This property is required. String
type This property is required. String
authenticateCognitos This property is required. GetListenerDefaultActionAuthenticateCognito[]
authenticateOidcs This property is required. GetListenerDefaultActionAuthenticateOidc[]
fixedResponses This property is required. GetListenerDefaultActionFixedResponse[]
forwards This property is required. GetListenerDefaultActionForward[]
order This property is required. number
redirects This property is required. GetListenerDefaultActionRedirect[]
targetGroupArn This property is required. string
type This property is required. string
authenticate_cognitos This property is required. Sequence[GetListenerDefaultActionAuthenticateCognito]
authenticate_oidcs This property is required. Sequence[GetListenerDefaultActionAuthenticateOidc]
fixed_responses This property is required. Sequence[GetListenerDefaultActionFixedResponse]
forwards This property is required. Sequence[GetListenerDefaultActionForward]
order This property is required. int
redirects This property is required. Sequence[GetListenerDefaultActionRedirect]
target_group_arn This property is required. str
type This property is required. str
authenticateCognitos This property is required. List<Property Map>
authenticateOidcs This property is required. List<Property Map>
fixedResponses This property is required. List<Property Map>
forwards This property is required. List<Property Map>
order This property is required. Number
redirects This property is required. List<Property Map>
targetGroupArn This property is required. String
type This property is required. String

GetListenerDefaultActionAuthenticateCognito

AuthenticationRequestExtraParams This property is required. Dictionary<string, string>
OnUnauthenticatedRequest This property is required. string
Scope This property is required. string
SessionCookieName This property is required. string
SessionTimeout This property is required. int
UserPoolArn This property is required. string
UserPoolClientId This property is required. string
UserPoolDomain This property is required. string
AuthenticationRequestExtraParams This property is required. map[string]string
OnUnauthenticatedRequest This property is required. string
Scope This property is required. string
SessionCookieName This property is required. string
SessionTimeout This property is required. int
UserPoolArn This property is required. string
UserPoolClientId This property is required. string
UserPoolDomain This property is required. string
authenticationRequestExtraParams This property is required. Map<String,String>
onUnauthenticatedRequest This property is required. String
scope This property is required. String
sessionCookieName This property is required. String
sessionTimeout This property is required. Integer
userPoolArn This property is required. String
userPoolClientId This property is required. String
userPoolDomain This property is required. String
authenticationRequestExtraParams This property is required. {[key: string]: string}
onUnauthenticatedRequest This property is required. string
scope This property is required. string
sessionCookieName This property is required. string
sessionTimeout This property is required. number
userPoolArn This property is required. string
userPoolClientId This property is required. string
userPoolDomain This property is required. string
authentication_request_extra_params This property is required. Mapping[str, str]
on_unauthenticated_request This property is required. str
scope This property is required. str
session_cookie_name This property is required. str
session_timeout This property is required. int
user_pool_arn This property is required. str
user_pool_client_id This property is required. str
user_pool_domain This property is required. str
authenticationRequestExtraParams This property is required. Map<String>
onUnauthenticatedRequest This property is required. String
scope This property is required. String
sessionCookieName This property is required. String
sessionTimeout This property is required. Number
userPoolArn This property is required. String
userPoolClientId This property is required. String
userPoolDomain This property is required. String

GetListenerDefaultActionAuthenticateOidc

AuthenticationRequestExtraParams This property is required. Dictionary<string, string>
AuthorizationEndpoint This property is required. string
ClientId This property is required. string
ClientSecret This property is required. string
Issuer This property is required. string
OnUnauthenticatedRequest This property is required. string
Scope This property is required. string
SessionCookieName This property is required. string
SessionTimeout This property is required. int
TokenEndpoint This property is required. string
UserInfoEndpoint This property is required. string
AuthenticationRequestExtraParams This property is required. map[string]string
AuthorizationEndpoint This property is required. string
ClientId This property is required. string
ClientSecret This property is required. string
Issuer This property is required. string
OnUnauthenticatedRequest This property is required. string
Scope This property is required. string
SessionCookieName This property is required. string
SessionTimeout This property is required. int
TokenEndpoint This property is required. string
UserInfoEndpoint This property is required. string
authenticationRequestExtraParams This property is required. Map<String,String>
authorizationEndpoint This property is required. String
clientId This property is required. String
clientSecret This property is required. String
issuer This property is required. String
onUnauthenticatedRequest This property is required. String
scope This property is required. String
sessionCookieName This property is required. String
sessionTimeout This property is required. Integer
tokenEndpoint This property is required. String
userInfoEndpoint This property is required. String
authenticationRequestExtraParams This property is required. {[key: string]: string}
authorizationEndpoint This property is required. string
clientId This property is required. string
clientSecret This property is required. string
issuer This property is required. string
onUnauthenticatedRequest This property is required. string
scope This property is required. string
sessionCookieName This property is required. string
sessionTimeout This property is required. number
tokenEndpoint This property is required. string
userInfoEndpoint This property is required. string
authentication_request_extra_params This property is required. Mapping[str, str]
authorization_endpoint This property is required. str
client_id This property is required. str
client_secret This property is required. str
issuer This property is required. str
on_unauthenticated_request This property is required. str
scope This property is required. str
session_cookie_name This property is required. str
session_timeout This property is required. int
token_endpoint This property is required. str
user_info_endpoint This property is required. str
authenticationRequestExtraParams This property is required. Map<String>
authorizationEndpoint This property is required. String
clientId This property is required. String
clientSecret This property is required. String
issuer This property is required. String
onUnauthenticatedRequest This property is required. String
scope This property is required. String
sessionCookieName This property is required. String
sessionTimeout This property is required. Number
tokenEndpoint This property is required. String
userInfoEndpoint This property is required. String

GetListenerDefaultActionFixedResponse

ContentType This property is required. string
MessageBody This property is required. string
StatusCode This property is required. string
ContentType This property is required. string
MessageBody This property is required. string
StatusCode This property is required. string
contentType This property is required. String
messageBody This property is required. String
statusCode This property is required. String
contentType This property is required. string
messageBody This property is required. string
statusCode This property is required. string
content_type This property is required. str
message_body This property is required. str
status_code This property is required. str
contentType This property is required. String
messageBody This property is required. String
statusCode This property is required. String

GetListenerDefaultActionForward

stickinesses This property is required. List<Property Map>
targetGroups This property is required. List<Property Map>

GetListenerDefaultActionForwardStickiness

Duration This property is required. int
Enabled This property is required. bool
Duration This property is required. int
Enabled This property is required. bool
duration This property is required. Integer
enabled This property is required. Boolean
duration This property is required. number
enabled This property is required. boolean
duration This property is required. int
enabled This property is required. bool
duration This property is required. Number
enabled This property is required. Boolean

GetListenerDefaultActionForwardTargetGroup

Arn This property is required. string
ARN of the listener. Required if load_balancer_arn and port is not set.
Weight This property is required. int
Arn This property is required. string
ARN of the listener. Required if load_balancer_arn and port is not set.
Weight This property is required. int
arn This property is required. String
ARN of the listener. Required if load_balancer_arn and port is not set.
weight This property is required. Integer
arn This property is required. string
ARN of the listener. Required if load_balancer_arn and port is not set.
weight This property is required. number
arn This property is required. str
ARN of the listener. Required if load_balancer_arn and port is not set.
weight This property is required. int
arn This property is required. String
ARN of the listener. Required if load_balancer_arn and port is not set.
weight This property is required. Number

GetListenerDefaultActionRedirect

Host This property is required. string
Path This property is required. string
Port This property is required. string
Port of the listener. Required if arn is not set.
Protocol This property is required. string
Query This property is required. string
StatusCode This property is required. string
Host This property is required. string
Path This property is required. string
Port This property is required. string
Port of the listener. Required if arn is not set.
Protocol This property is required. string
Query This property is required. string
StatusCode This property is required. string
host This property is required. String
path This property is required. String
port This property is required. String
Port of the listener. Required if arn is not set.
protocol This property is required. String
query This property is required. String
statusCode This property is required. String
host This property is required. string
path This property is required. string
port This property is required. string
Port of the listener. Required if arn is not set.
protocol This property is required. string
query This property is required. string
statusCode This property is required. string
host This property is required. str
path This property is required. str
port This property is required. str
Port of the listener. Required if arn is not set.
protocol This property is required. str
query This property is required. str
status_code This property is required. str
host This property is required. String
path This property is required. String
port This property is required. String
Port of the listener. Required if arn is not set.
protocol This property is required. String
query This property is required. String
statusCode This property is required. String

GetListenerMutualAuthentication

AdvertiseTrustStoreCaNames This property is required. string
IgnoreClientCertificateExpiry This property is required. bool
Mode This property is required. string
TrustStoreArn This property is required. string
AdvertiseTrustStoreCaNames This property is required. string
IgnoreClientCertificateExpiry This property is required. bool
Mode This property is required. string
TrustStoreArn This property is required. string
advertiseTrustStoreCaNames This property is required. String
ignoreClientCertificateExpiry This property is required. Boolean
mode This property is required. String
trustStoreArn This property is required. String
advertiseTrustStoreCaNames This property is required. string
ignoreClientCertificateExpiry This property is required. boolean
mode This property is required. string
trustStoreArn This property is required. string
This property is required. str
ignore_client_certificate_expiry This property is required. bool
mode This property is required. str
trust_store_arn This property is required. str
advertiseTrustStoreCaNames This property is required. String
ignoreClientCertificateExpiry This property is required. Boolean
mode This property is required. String
trustStoreArn This property is required. String

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi