aws-native.vpclattice.getListener

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

function getListener(args: GetListenerArgs, opts?: InvokeOptions): Promise<GetListenerResult>
function getListenerOutput(args: GetListenerOutputArgs, opts?: InvokeOptions): Output<GetListenerResult>

def get_listener(arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetListenerResult
def get_listener_output(arn: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetListenerResult]

func LookupListener(ctx *Context, args *LookupListenerArgs, opts ...InvokeOption) (*LookupListenerResult, error)
func LookupListenerOutput(ctx *Context, args *LookupListenerOutputArgs, opts ...InvokeOption) LookupListenerResultOutput

> 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)
}

public static CompletableFuture<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
public static Output<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:vpclattice:getListener
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: The Amazon Resource Name (ARN) of the listener.

Arn string: The Amazon Resource Name (ARN) of the listener.

arn String: The Amazon Resource Name (ARN) of the listener.

arn string: The Amazon Resource Name (ARN) of the listener.

arn str: The Amazon Resource Name (ARN) of the listener.

arn String: The Amazon Resource Name (ARN) of the listener.

getListener Result

The following output properties are available:

Arn string: The Amazon Resource Name (ARN) of the listener.
DefaultAction Pulumi.AwsNative.VpcLattice.Outputs.ListenerDefaultAction: The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
Id string: The ID of the listener.
ServiceArn string: The Amazon Resource Name (ARN) of the service.
ServiceId string: The ID of the service.
Tags List<Pulumi.AwsNative.Outputs.Tag>: The tags for the listener.

Arn string: The Amazon Resource Name (ARN) of the listener.
DefaultAction ListenerDefaultAction: The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
Id string: The ID of the listener.
ServiceArn string: The Amazon Resource Name (ARN) of the service.
ServiceId string: The ID of the service.
Tags Tag: The tags for the listener.

arn String: The Amazon Resource Name (ARN) of the listener.
defaultAction ListenerDefaultAction: The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
id String: The ID of the listener.
serviceArn String: The Amazon Resource Name (ARN) of the service.
serviceId String: The ID of the service.
tags List<Tag>: The tags for the listener.

arn string: The Amazon Resource Name (ARN) of the listener.
defaultAction ListenerDefaultAction: The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
id string: The ID of the listener.
serviceArn string: The Amazon Resource Name (ARN) of the service.
serviceId string: The ID of the service.
tags Tag[]: The tags for the listener.

arn str: The Amazon Resource Name (ARN) of the listener.
default_action ListenerDefaultAction: The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
id str: The ID of the listener.
service_arn str: The Amazon Resource Name (ARN) of the service.
service_id str: The ID of the service.
tags Sequence[root_Tag]: The tags for the listener.

arn String: The Amazon Resource Name (ARN) of the listener.
defaultAction Property Map: The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
id String: The ID of the listener.
serviceArn String: The Amazon Resource Name (ARN) of the service.
serviceId String: The ID of the service.
tags List<Property Map>: The tags for the listener.

Supporting Types

ListenerDefaultAction

FixedResponse Pulumi.AwsNative.VpcLattice.Inputs.ListenerFixedResponse: Describes an action that returns a custom HTTP response.
Forward Pulumi.AwsNative.VpcLattice.Inputs.ListenerForward: Describes a forward action. You can use forward actions to route requests to one or more target groups.

FixedResponse ListenerFixedResponse: Describes an action that returns a custom HTTP response.
Forward ListenerForward: Describes a forward action. You can use forward actions to route requests to one or more target groups.

fixedResponse ListenerFixedResponse: Describes an action that returns a custom HTTP response.
forward ListenerForward: Describes a forward action. You can use forward actions to route requests to one or more target groups.

fixedResponse ListenerFixedResponse: Describes an action that returns a custom HTTP response.
forward ListenerForward: Describes a forward action. You can use forward actions to route requests to one or more target groups.

fixed_response ListenerFixedResponse: Describes an action that returns a custom HTTP response.
forward ListenerForward: Describes a forward action. You can use forward actions to route requests to one or more target groups.

fixedResponse Property Map: Describes an action that returns a custom HTTP response.
forward Property Map: Describes a forward action. You can use forward actions to route requests to one or more target groups.

ListenerFixedResponse

StatusCode int: The HTTP response code.

StatusCode int: The HTTP response code.

statusCode Integer: The HTTP response code.

statusCode number: The HTTP response code.

status_code int: The HTTP response code.

statusCode Number: The HTTP response code.

ListenerForward

TargetGroups List<Pulumi.AwsNative.VpcLattice.Inputs.ListenerWeightedTargetGroup>

The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.