AWS v6.71.0, Mar 7 25

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

aws.lb.getListenerRule

Explore with Pulumi AI

AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Match by Rule ARN

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

const config = new pulumi.Config();
const lbRuleArn = config.require("lbRuleArn");
const example = aws.lb.getListenerRule({
    arn: lbRuleArn,
});

import pulumi
import pulumi_aws as aws

config = pulumi.Config()
lb_rule_arn = config.require("lbRuleArn")
example = aws.lb.get_listener_rule(arn=lb_rule_arn)

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, "")
		lbRuleArn := cfg.Require("lbRuleArn")
		_, err := lb.LookupListenerRule(ctx, &lb.LookupListenerRuleArgs{
			Arn: pulumi.StringRef(lbRuleArn),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var lbRuleArn = config.Require("lbRuleArn");
    var example = Aws.LB.GetListenerRule.Invoke(new()
    {
        Arn = lbRuleArn,
    });

});

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.GetListenerRuleArgs;
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 lbRuleArn = config.get("lbRuleArn");
        final var example = LbFunctions.getListenerRule(GetListenerRuleArgs.builder()
            .arn(lbRuleArn)
            .build());

    }
}

configuration:
  lbRuleArn:
    type: string
variables:
  example:
    fn::invoke:
      function: aws:lb:getListenerRule
      arguments:
        arn: ${lbRuleArn}

Match by Listener ARN and Priority

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

const config = new pulumi.Config();
const lbListenerArn = config.require("lbListenerArn");
const lbRulePriority = config.requireNumber("lbRulePriority");
const example = aws.lb.getListenerRule({
    listenerArn: lbListenerArn,
    priority: lbRulePriority,
});

import pulumi
import pulumi_aws as aws

config = pulumi.Config()
lb_listener_arn = config.require("lbListenerArn")
lb_rule_priority = config.require_float("lbRulePriority")
example = aws.lb.get_listener_rule(listener_arn=lb_listener_arn,
    priority=lb_rule_priority)

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, "")
		lbListenerArn := cfg.Require("lbListenerArn")
		lbRulePriority := cfg.RequireFloat64("lbRulePriority")
		_, err := lb.LookupListenerRule(ctx, &lb.LookupListenerRuleArgs{
			ListenerArn: pulumi.StringRef(lbListenerArn),
			Priority:    pulumi.IntRef(lbRulePriority),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var lbListenerArn = config.Require("lbListenerArn");
    var lbRulePriority = config.RequireDouble("lbRulePriority");
    var example = Aws.LB.GetListenerRule.Invoke(new()
    {
        ListenerArn = lbListenerArn,
        Priority = lbRulePriority,
    });

});

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.GetListenerRuleArgs;
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 lbListenerArn = config.get("lbListenerArn");
        final var lbRulePriority = config.get("lbRulePriority");
        final var example = LbFunctions.getListenerRule(GetListenerRuleArgs.builder()
            .listenerArn(lbListenerArn)
            .priority(lbRulePriority)
            .build());

    }
}

configuration:
  lbListenerArn:
    type: string
  lbRulePriority:
    type: number
variables:
  example:
    fn::invoke:
      function: aws:lb:getListenerRule
      arguments:
        listenerArn: ${lbListenerArn}
        priority: ${lbRulePriority}

Using getListenerRule

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 getListenerRule(args: GetListenerRuleArgs, opts?: InvokeOptions): Promise<GetListenerRuleResult>
function getListenerRuleOutput(args: GetListenerRuleOutputArgs, opts?: InvokeOptions): Output<GetListenerRuleResult>

def get_listener_rule(actions: Optional[Sequence[GetListenerRuleAction]] = None,
                      arn: Optional[str] = None,
                      conditions: Optional[Sequence[GetListenerRuleCondition]] = None,
                      listener_arn: Optional[str] = None,
                      priority: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetListenerRuleResult
def get_listener_rule_output(actions: Optional[pulumi.Input[Sequence[pulumi.Input[GetListenerRuleActionArgs]]]] = None,
                      arn: Optional[pulumi.Input[str]] = None,
                      conditions: Optional[pulumi.Input[Sequence[pulumi.Input[GetListenerRuleConditionArgs]]]] = None,
                      listener_arn: Optional[pulumi.Input[str]] = None,
                      priority: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetListenerRuleResult]

func LookupListenerRule(ctx *Context, args *LookupListenerRuleArgs, opts ...InvokeOption) (*LookupListenerRuleResult, error)
func LookupListenerRuleOutput(ctx *Context, args *LookupListenerRuleOutputArgs, opts ...InvokeOption) LookupListenerRuleResultOutput

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

public static class GetListenerRule 
{
    public static Task<GetListenerRuleResult> InvokeAsync(GetListenerRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetListenerRuleResult> Invoke(GetListenerRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetListenerRuleResult> getListenerRule(GetListenerRuleArgs args, InvokeOptions options)
public static Output<GetListenerRuleResult> getListenerRule(GetListenerRuleArgs args, InvokeOptions options)

fn::invoke:
  function: aws:lb/getListenerRule:getListenerRule
  arguments:
    # arguments dictionary

The following arguments are supported:

Actions List<GetListenerRuleAction>: List of actions associated with the rule, sorted by order. Detailed below.
Arn string: ARN of the Listener Rule. Either arn or listener_arn must be set.
Conditions List<GetListenerRuleCondition>: Set of conditions associated with the rule. Detailed below.
ListenerArn string: ARN of the associated Listener. Either arn or listener_arn must be set.
Priority int: Priority of the Listener Rule within the Listener. Must be set if listener_arn is set, otherwise must not be set.

Actions []GetListenerRuleAction: List of actions associated with the rule, sorted by order. Detailed below.
Arn string: ARN of the Listener Rule. Either arn or listener_arn must be set.
Conditions []GetListenerRuleCondition: Set of conditions associated with the rule. Detailed below.
ListenerArn string: ARN of the associated Listener. Either arn or listener_arn must be set.
Priority int: Priority of the Listener Rule within the Listener. Must be set if listener_arn is set, otherwise must not be set.

actions List<GetListenerRuleAction>: List of actions associated with the rule, sorted by order. Detailed below.
arn String: ARN of the Listener Rule. Either arn or listener_arn must be set.
conditions List<GetListenerRuleCondition>: Set of conditions associated with the rule. Detailed below.
listenerArn String: ARN of the associated Listener. Either arn or listener_arn must be set.
priority Integer: Priority of the Listener Rule within the Listener. Must be set if listener_arn is set, otherwise must not be set.

actions GetListenerRuleAction[]: List of actions associated with the rule, sorted by order. Detailed below.
arn string: ARN of the Listener Rule. Either arn or listener_arn must be set.
conditions GetListenerRuleCondition[]: Set of conditions associated with the rule. Detailed below.
listenerArn string: ARN of the associated Listener. Either arn or listener_arn must be set.
priority number: Priority of the Listener Rule within the Listener. Must be set if listener_arn is set, otherwise must not be set.

actions Sequence[GetListenerRuleAction]: List of actions associated with the rule, sorted by order. Detailed below.
arn str: ARN of the Listener Rule. Either arn or listener_arn must be set.
conditions Sequence[GetListenerRuleCondition]: Set of conditions associated with the rule. Detailed below.
listener_arn str: ARN of the associated Listener. Either arn or listener_arn must be set.
priority int: Priority of the Listener Rule within the Listener. Must be set if listener_arn is set, otherwise must not be set.

actions List<Property Map>: List of actions associated with the rule, sorted by order. Detailed below.
arn String: ARN of the Listener Rule. Either arn or listener_arn must be set.
conditions List<Property Map>: Set of conditions associated with the rule. Detailed below.
listenerArn String: ARN of the associated Listener. Either arn or listener_arn must be set.
priority Number: Priority of the Listener Rule within the Listener. Must be set if listener_arn is set, otherwise must not be set.

getListenerRule Result

The following output properties are available:

Arn string: ARN of the target group.
Id string: The provider-assigned unique ID for this managed resource.
ListenerArn string
Priority int
Tags Dictionary<string, string>: Tags assigned to the Listener Rule.
Actions List<GetListenerRuleAction>: List of actions associated with the rule, sorted by order. Detailed below.
Conditions List<GetListenerRuleCondition>: Set of conditions associated with the rule. Detailed below.

Arn string: ARN of the target group.
Id string: The provider-assigned unique ID for this managed resource.
ListenerArn string
Priority int
Tags map[string]string: Tags assigned to the Listener Rule.
Actions []GetListenerRuleAction: List of actions associated with the rule, sorted by order. Detailed below.
Conditions []GetListenerRuleCondition: Set of conditions associated with the rule. Detailed below.

arn String: ARN of the target group.
id String: The provider-assigned unique ID for this managed resource.
listenerArn String
priority Integer
tags Map<String,String>: Tags assigned to the Listener Rule.
actions List<GetListenerRuleAction>: List of actions associated with the rule, sorted by order. Detailed below.
conditions List<GetListenerRuleCondition>: Set of conditions associated with the rule. Detailed below.

arn string: ARN of the target group.
id string: The provider-assigned unique ID for this managed resource.
listenerArn string
priority number
tags {[key: string]: string}: Tags assigned to the Listener Rule.
actions GetListenerRuleAction[]: List of actions associated with the rule, sorted by order. Detailed below.
conditions GetListenerRuleCondition[]: Set of conditions associated with the rule. Detailed below.

arn str: ARN of the target group.
id str: The provider-assigned unique ID for this managed resource.
listener_arn str
priority int
tags Mapping[str, str]: Tags assigned to the Listener Rule.
actions Sequence[GetListenerRuleAction]: List of actions associated with the rule, sorted by order. Detailed below.
conditions Sequence[GetListenerRuleCondition]: Set of conditions associated with the rule. Detailed below.

arn String: ARN of the target group.
id String: The provider-assigned unique ID for this managed resource.
listenerArn String
priority Number
tags Map<String>: Tags assigned to the Listener Rule.
actions List<Property Map>: List of actions associated with the rule, sorted by order. Detailed below.
conditions List<Property Map>: Set of conditions associated with the rule. Detailed below.

Supporting Types

GetListenerRuleAction

Order int: The evaluation order of the action.
Type string: The type of the action, indicates which sub-block will be populated.
AuthenticateCognito GetListenerRuleActionAuthenticateCognito: An action to authenticate using Amazon Cognito. Detailed below.
AuthenticateOidc GetListenerRuleActionAuthenticateOidc: An action to authenticate using OIDC. Detailed below.
FixedResponse GetListenerRuleActionFixedResponse: An action to return a fixed response. Detailed below.
Forward GetListenerRuleActionForward: An action to forward the request. Detailed below.
Redirect GetListenerRuleActionRedirect: An action to redirect the request. Detailed below.

Order int: The evaluation order of the action.
Type string: The type of the action, indicates which sub-block will be populated.
AuthenticateCognito GetListenerRuleActionAuthenticateCognito: An action to authenticate using Amazon Cognito. Detailed below.
AuthenticateOidc GetListenerRuleActionAuthenticateOidc: An action to authenticate using OIDC. Detailed below.
FixedResponse GetListenerRuleActionFixedResponse: An action to return a fixed response. Detailed below.
Forward GetListenerRuleActionForward: An action to forward the request. Detailed below.
Redirect GetListenerRuleActionRedirect: An action to redirect the request. Detailed below.

order Integer: The evaluation order of the action.
type String: The type of the action, indicates which sub-block will be populated.
authenticateCognito GetListenerRuleActionAuthenticateCognito: An action to authenticate using Amazon Cognito. Detailed below.
authenticateOidc GetListenerRuleActionAuthenticateOidc: An action to authenticate using OIDC. Detailed below.
fixedResponse GetListenerRuleActionFixedResponse: An action to return a fixed response. Detailed below.
forward GetListenerRuleActionForward: An action to forward the request. Detailed below.
redirect GetListenerRuleActionRedirect: An action to redirect the request. Detailed below.

order number: The evaluation order of the action.
type string: The type of the action, indicates which sub-block will be populated.
authenticateCognito GetListenerRuleActionAuthenticateCognito: An action to authenticate using Amazon Cognito. Detailed below.
authenticateOidc GetListenerRuleActionAuthenticateOidc: An action to authenticate using OIDC. Detailed below.
fixedResponse GetListenerRuleActionFixedResponse: An action to return a fixed response. Detailed below.
forward GetListenerRuleActionForward: An action to forward the request. Detailed below.
redirect GetListenerRuleActionRedirect: An action to redirect the request. Detailed below.

order int: The evaluation order of the action.
type str: The type of the action, indicates which sub-block will be populated.
authenticate_cognito GetListenerRuleActionAuthenticateCognito: An action to authenticate using Amazon Cognito. Detailed below.
authenticate_oidc GetListenerRuleActionAuthenticateOidc: An action to authenticate using OIDC. Detailed below.
fixed_response GetListenerRuleActionFixedResponse: An action to return a fixed response. Detailed below.
forward GetListenerRuleActionForward: An action to forward the request. Detailed below.
redirect GetListenerRuleActionRedirect: An action to redirect the request. Detailed below.

order Number: The evaluation order of the action.
type String: The type of the action, indicates which sub-block will be populated.
authenticateCognito Property Map: An action to authenticate using Amazon Cognito. Detailed below.
authenticateOidc Property Map: An action to authenticate using OIDC. Detailed below.
fixedResponse Property Map: An action to return a fixed response. Detailed below.
forward Property Map: An action to forward the request. Detailed below.
redirect Property Map: An action to redirect the request. Detailed below.

GetListenerRuleActionAuthenticateCognito

AuthenticationRequestExtraParams Dictionary<string, string>: Set of additional parameters for the request. Detailed below.
OnUnauthenticatedRequest string: Behavior when the client is not authenticated.
Scope string: Set of user claims requested.
SessionCookieName string: Name of the cookie used to maintain session information.
SessionTimeout int: Maximum duration of the authentication session in seconds.
UserPoolArn string: ARN of the Cognito user pool.
UserPoolClientId string: ID of the Cognito user pool client.
UserPoolDomain string: Domain prefix or fully-qualified domain name of the Cognito user pool.

AuthenticationRequestExtraParams map[string]string: Set of additional parameters for the request. Detailed below.
OnUnauthenticatedRequest string: Behavior when the client is not authenticated.
Scope string: Set of user claims requested.
SessionCookieName string: Name of the cookie used to maintain session information.
SessionTimeout int: Maximum duration of the authentication session in seconds.
UserPoolArn string: ARN of the Cognito user pool.
UserPoolClientId string: ID of the Cognito user pool client.
UserPoolDomain string: Domain prefix or fully-qualified domain name of the Cognito user pool.

authenticationRequestExtraParams Map<String,String>: Set of additional parameters for the request. Detailed below.
onUnauthenticatedRequest String: Behavior when the client is not authenticated.
scope String: Set of user claims requested.
sessionCookieName String: Name of the cookie used to maintain session information.
sessionTimeout Integer: Maximum duration of the authentication session in seconds.
userPoolArn String: ARN of the Cognito user pool.
userPoolClientId String: ID of the Cognito user pool client.
userPoolDomain String: Domain prefix or fully-qualified domain name of the Cognito user pool.

authenticationRequestExtraParams {[key: string]: string}: Set of additional parameters for the request. Detailed below.
onUnauthenticatedRequest string: Behavior when the client is not authenticated.
scope string: Set of user claims requested.
sessionCookieName string: Name of the cookie used to maintain session information.
sessionTimeout number: Maximum duration of the authentication session in seconds.
userPoolArn string: ARN of the Cognito user pool.
userPoolClientId string: ID of the Cognito user pool client.
userPoolDomain string: Domain prefix or fully-qualified domain name of the Cognito user pool.

authentication_request_extra_params Mapping[str, str]: Set of additional parameters for the request. Detailed below.
on_unauthenticated_request str: Behavior when the client is not authenticated.
scope str: Set of user claims requested.
session_cookie_name str: Name of the cookie used to maintain session information.
session_timeout int: Maximum duration of the authentication session in seconds.
user_pool_arn str: ARN of the Cognito user pool.
user_pool_client_id str: ID of the Cognito user pool client.
user_pool_domain str: Domain prefix or fully-qualified domain name of the Cognito user pool.

authenticationRequestExtraParams Map<String>: Set of additional parameters for the request. Detailed below.
onUnauthenticatedRequest String: Behavior when the client is not authenticated.
scope String: Set of user claims requested.
sessionCookieName String: Name of the cookie used to maintain session information.
sessionTimeout Number: Maximum duration of the authentication session in seconds.
userPoolArn String: ARN of the Cognito user pool.
userPoolClientId String: ID of the Cognito user pool client.
userPoolDomain String: Domain prefix or fully-qualified domain name of the Cognito user pool.

GetListenerRuleActionAuthenticateOidc

AuthenticationRequestExtraParams Dictionary<string, string>: Set of additional parameters for the request. Detailed below.
AuthorizationEndpoint string: The authorization endpoint of the IdP.
ClientId string: OAuth 2.0 client identifier.
Issuer string: OIDC issuer identifier of the IdP.
OnUnauthenticatedRequest string: Behavior when the client is not authenticated.
Scope string: Set of user claims requested.
SessionCookieName string: Name of the cookie used to maintain session information.
SessionTimeout int: Maximum duration of the authentication session in seconds.
TokenEndpoint string: The token endpoint of the IdP.
UserInfoEndpoint string: The user info endpoint of the IdP.

AuthenticationRequestExtraParams map[string]string: Set of additional parameters for the request. Detailed below.
AuthorizationEndpoint string: The authorization endpoint of the IdP.
ClientId string: OAuth 2.0 client identifier.
Issuer string: OIDC issuer identifier of the IdP.
OnUnauthenticatedRequest string: Behavior when the client is not authenticated.
Scope string: Set of user claims requested.
SessionCookieName string: Name of the cookie used to maintain session information.
SessionTimeout int: Maximum duration of the authentication session in seconds.
TokenEndpoint string: The token endpoint of the IdP.
UserInfoEndpoint string: The user info endpoint of the IdP.

authenticationRequestExtraParams Map<String,String>: Set of additional parameters for the request. Detailed below.
authorizationEndpoint String: The authorization endpoint of the IdP.
clientId String: OAuth 2.0 client identifier.
issuer String: OIDC issuer identifier of the IdP.
onUnauthenticatedRequest String: Behavior when the client is not authenticated.
scope String: Set of user claims requested.
sessionCookieName String: Name of the cookie used to maintain session information.
sessionTimeout Integer: Maximum duration of the authentication session in seconds.
tokenEndpoint String: The token endpoint of the IdP.
userInfoEndpoint String: The user info endpoint of the IdP.

authenticationRequestExtraParams {[key: string]: string}: Set of additional parameters for the request. Detailed below.
authorizationEndpoint string: The authorization endpoint of the IdP.
clientId string: OAuth 2.0 client identifier.
issuer string: OIDC issuer identifier of the IdP.
onUnauthenticatedRequest string: Behavior when the client is not authenticated.
scope string: Set of user claims requested.
sessionCookieName string: Name of the cookie used to maintain session information.
sessionTimeout number: Maximum duration of the authentication session in seconds.
tokenEndpoint string: The token endpoint of the IdP.
userInfoEndpoint string: The user info endpoint of the IdP.

authentication_request_extra_params Mapping[str, str]: Set of additional parameters for the request. Detailed below.
authorization_endpoint str: The authorization endpoint of the IdP.
client_id str: OAuth 2.0 client identifier.
issuer str: OIDC issuer identifier of the IdP.
on_unauthenticated_request str: Behavior when the client is not authenticated.
scope str: Set of user claims requested.
session_cookie_name str: Name of the cookie used to maintain session information.
session_timeout int: Maximum duration of the authentication session in seconds.
token_endpoint str: The token endpoint of the IdP.
user_info_endpoint str: The user info endpoint of the IdP.

authenticationRequestExtraParams Map<String>: Set of additional parameters for the request. Detailed below.
authorizationEndpoint String: The authorization endpoint of the IdP.
clientId String: OAuth 2.0 client identifier.
issuer String: OIDC issuer identifier of the IdP.
onUnauthenticatedRequest String: Behavior when the client is not authenticated.
scope String: Set of user claims requested.
sessionCookieName String: Name of the cookie used to maintain session information.
sessionTimeout Number: Maximum duration of the authentication session in seconds.
tokenEndpoint String: The token endpoint of the IdP.
userInfoEndpoint String: The user info endpoint of the IdP.

GetListenerRuleActionFixedResponse

ContentType string: Content type of the response.
MessageBody string: Message body of the response.
StatusCode string: The HTTP redirect code.

ContentType string: Content type of the response.
MessageBody string: Message body of the response.
StatusCode string: The HTTP redirect code.

contentType String: Content type of the response.
messageBody String: Message body of the response.
statusCode String: The HTTP redirect code.

contentType string: Content type of the response.
messageBody string: Message body of the response.
statusCode string: The HTTP redirect code.

content_type str: Content type of the response.
message_body str: Message body of the response.
status_code str: The HTTP redirect code.

contentType String: Content type of the response.
messageBody String: Message body of the response.
statusCode String: The HTTP redirect code.

GetListenerRuleActionForward

Stickiness GetListenerRuleActionForwardStickiness: Target group stickiness for the rule. Detailed below.
TargetGroups List<GetListenerRuleActionForwardTargetGroup>: Set of target groups for the action. Detailed below.

Stickiness GetListenerRuleActionForwardStickiness: Target group stickiness for the rule. Detailed below.
TargetGroups []GetListenerRuleActionForwardTargetGroup: Set of target groups for the action. Detailed below.

stickiness GetListenerRuleActionForwardStickiness: Target group stickiness for the rule. Detailed below.
targetGroups List<GetListenerRuleActionForwardTargetGroup>: Set of target groups for the action. Detailed below.

stickiness GetListenerRuleActionForwardStickiness: Target group stickiness for the rule. Detailed below.
targetGroups GetListenerRuleActionForwardTargetGroup[]: Set of target groups for the action. Detailed below.

stickiness GetListenerRuleActionForwardStickiness: Target group stickiness for the rule. Detailed below.
target_groups Sequence[GetListenerRuleActionForwardTargetGroup]: Set of target groups for the action. Detailed below.

stickiness Property Map: Target group stickiness for the rule. Detailed below.
targetGroups List<Property Map>: Set of target groups for the action. Detailed below.

GetListenerRuleActionForwardStickiness

Duration int: The time period, in seconds, during which requests from a client should be routed to the same target group.
Enabled bool: Indicates whether target group stickiness is enabled.

Duration int: The time period, in seconds, during which requests from a client should be routed to the same target group.
Enabled bool: Indicates whether target group stickiness is enabled.

duration Integer: The time period, in seconds, during which requests from a client should be routed to the same target group.
enabled Boolean: Indicates whether target group stickiness is enabled.

duration number: The time period, in seconds, during which requests from a client should be routed to the same target group.
enabled boolean: Indicates whether target group stickiness is enabled.

duration int: The time period, in seconds, during which requests from a client should be routed to the same target group.
enabled bool: Indicates whether target group stickiness is enabled.

duration Number: The time period, in seconds, during which requests from a client should be routed to the same target group.
enabled Boolean: Indicates whether target group stickiness is enabled.

GetListenerRuleActionForwardTargetGroup

Arn string: ARN of the Listener Rule. Either arn or listener_arn must be set.
Weight int: Weight of the target group.

Arn string: ARN of the Listener Rule. Either arn or listener_arn must be set.
Weight int: Weight of the target group.

arn String: ARN of the Listener Rule. Either arn or listener_arn must be set.
weight Integer: Weight of the target group.

arn string: ARN of the Listener Rule. Either arn or listener_arn must be set.
weight number: Weight of the target group.

arn str: ARN of the Listener Rule. Either arn or listener_arn must be set.
weight int: Weight of the target group.

arn String: ARN of the Listener Rule. Either arn or listener_arn must be set.
weight Number: Weight of the target group.

GetListenerRuleActionRedirect

Host string: The hostname.
Path string: The absolute path, starting with /.
Port string: The port.
Protocol string: The protocol.
Query string: The query parameters.
StatusCode string: The HTTP redirect code.

Host string: The hostname.
Path string: The absolute path, starting with /.
Port string: The port.
Protocol string: The protocol.
Query string: The query parameters.
StatusCode string: The HTTP redirect code.

host String: The hostname.
path String: The absolute path, starting with /.
port String: The port.
protocol String: The protocol.
query String: The query parameters.
statusCode String: The HTTP redirect code.

host string: The hostname.
path string: The absolute path, starting with /.
port string: The port.
protocol string: The protocol.
query string: The query parameters.
statusCode string: The HTTP redirect code.

host str: The hostname.
path str: The absolute path, starting with /.
port str: The port.
protocol str: The protocol.
query str: The query parameters.
status_code str: The HTTP redirect code.

host String: The hostname.
path String: The absolute path, starting with /.
port String: The port.
protocol String: The protocol.
query String: The query parameters.
statusCode String: The HTTP redirect code.

GetListenerRuleCondition

HostHeader GetListenerRuleConditionHostHeader: Contains a single attribute values, which contains a set of host names.
HttpHeader GetListenerRuleConditionHttpHeader: HTTP header and values to match. Detailed below.
HttpRequestMethod GetListenerRuleConditionHttpRequestMethod: Contains a single attribute values, which contains a set of HTTP request methods.
PathPattern GetListenerRuleConditionPathPattern: Contains a single attribute values, which contains a set of path patterns to compare against the request URL.
QueryString GetListenerRuleConditionQueryString: Query string parameters to match. Detailed below.
SourceIp GetListenerRuleConditionSourceIp: Contains a single attribute values, which contains a set of source IPs in CIDR notation.

HostHeader GetListenerRuleConditionHostHeader: Contains a single attribute values, which contains a set of host names.
HttpHeader GetListenerRuleConditionHttpHeader: HTTP header and values to match. Detailed below.
HttpRequestMethod GetListenerRuleConditionHttpRequestMethod: Contains a single attribute values, which contains a set of HTTP request methods.
PathPattern GetListenerRuleConditionPathPattern: Contains a single attribute values, which contains a set of path patterns to compare against the request URL.
QueryString GetListenerRuleConditionQueryString: Query string parameters to match. Detailed below.
SourceIp GetListenerRuleConditionSourceIp: Contains a single attribute values, which contains a set of source IPs in CIDR notation.

hostHeader GetListenerRuleConditionHostHeader: Contains a single attribute values, which contains a set of host names.
httpHeader GetListenerRuleConditionHttpHeader: HTTP header and values to match. Detailed below.
httpRequestMethod GetListenerRuleConditionHttpRequestMethod: Contains a single attribute values, which contains a set of HTTP request methods.
pathPattern GetListenerRuleConditionPathPattern: Contains a single attribute values, which contains a set of path patterns to compare against the request URL.
queryString GetListenerRuleConditionQueryString: Query string parameters to match. Detailed below.
sourceIp GetListenerRuleConditionSourceIp: Contains a single attribute values, which contains a set of source IPs in CIDR notation.

hostHeader GetListenerRuleConditionHostHeader: Contains a single attribute values, which contains a set of host names.
httpHeader GetListenerRuleConditionHttpHeader: HTTP header and values to match. Detailed below.
httpRequestMethod GetListenerRuleConditionHttpRequestMethod: Contains a single attribute values, which contains a set of HTTP request methods.
pathPattern GetListenerRuleConditionPathPattern: Contains a single attribute values, which contains a set of path patterns to compare against the request URL.
queryString GetListenerRuleConditionQueryString: Query string parameters to match. Detailed below.
sourceIp GetListenerRuleConditionSourceIp: Contains a single attribute values, which contains a set of source IPs in CIDR notation.

host_header GetListenerRuleConditionHostHeader: Contains a single attribute values, which contains a set of host names.
http_header GetListenerRuleConditionHttpHeader: HTTP header and values to match. Detailed below.
http_request_method GetListenerRuleConditionHttpRequestMethod: Contains a single attribute values, which contains a set of HTTP request methods.
path_pattern GetListenerRuleConditionPathPattern: Contains a single attribute values, which contains a set of path patterns to compare against the request URL.
query_string GetListenerRuleConditionQueryString: Query string parameters to match. Detailed below.
source_ip GetListenerRuleConditionSourceIp: Contains a single attribute values, which contains a set of source IPs in CIDR notation.

hostHeader Property Map: Contains a single attribute values, which contains a set of host names.
httpHeader Property Map: HTTP header and values to match. Detailed below.
httpRequestMethod Property Map: Contains a single attribute values, which contains a set of HTTP request methods.
pathPattern Property Map: Contains a single attribute values, which contains a set of path patterns to compare against the request URL.
queryString Property Map: Query string parameters to match. Detailed below.
sourceIp Property Map: Contains a single attribute values, which contains a set of source IPs in CIDR notation.

GetListenerRuleConditionHostHeader

Values List<string>: Set of key-value pairs indicating the query string parameters to match.

Values []string: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

values string[]: Set of key-value pairs indicating the query string parameters to match.

values Sequence[str]: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

GetListenerRuleConditionHttpHeader

HttpHeaderName string: Name of the HTTP header to match.
Values List<string>: Set of key-value pairs indicating the query string parameters to match.

HttpHeaderName string: Name of the HTTP header to match.
Values []string: Set of key-value pairs indicating the query string parameters to match.

httpHeaderName String: Name of the HTTP header to match.
values List<String>: Set of key-value pairs indicating the query string parameters to match.

httpHeaderName string: Name of the HTTP header to match.
values string[]: Set of key-value pairs indicating the query string parameters to match.

http_header_name str: Name of the HTTP header to match.
values Sequence[str]: Set of key-value pairs indicating the query string parameters to match.

httpHeaderName String: Name of the HTTP header to match.
values List<String>: Set of key-value pairs indicating the query string parameters to match.

GetListenerRuleConditionHttpRequestMethod

Values List<string>: Set of key-value pairs indicating the query string parameters to match.

Values []string: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

values string[]: Set of key-value pairs indicating the query string parameters to match.

values Sequence[str]: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

GetListenerRuleConditionPathPattern

Values List<string>: Set of key-value pairs indicating the query string parameters to match.

Values []string: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

values string[]: Set of key-value pairs indicating the query string parameters to match.

values Sequence[str]: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

GetListenerRuleConditionQueryString

Values List<GetListenerRuleConditionQueryStringValue>: Set of key-value pairs indicating the query string parameters to match.

Values []GetListenerRuleConditionQueryStringValue: Set of key-value pairs indicating the query string parameters to match.

values List<GetListenerRuleConditionQueryStringValue>: Set of key-value pairs indicating the query string parameters to match.

values GetListenerRuleConditionQueryStringValue[]: Set of key-value pairs indicating the query string parameters to match.

values Sequence[GetListenerRuleConditionQueryStringValue]: Set of key-value pairs indicating the query string parameters to match.

values List<Property Map>: Set of key-value pairs indicating the query string parameters to match.

GetListenerRuleConditionQueryStringValue

Key string: Key of query parameter
Value string: Value of query parameter

Key string: Key of query parameter
Value string: Value of query parameter

key String: Key of query parameter
value String: Value of query parameter

key string: Key of query parameter
value string: Value of query parameter

key str: Key of query parameter
value str: Value of query parameter

key String: Key of query parameter
value String: Value of query parameter

GetListenerRuleConditionSourceIp

Values List<string>: Set of key-value pairs indicating the query string parameters to match.

Values []string: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

values string[]: Set of key-value pairs indicating the query string parameters to match.

values Sequence[str]: Set of key-value pairs indicating the query string parameters to match.

values List<String>: Set of key-value pairs indicating the query string parameters to match.

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.71.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-aws

aws.lb.getListenerRule

On this page

On this page

Example Usage

Match by Rule ARN

Match by Listener ARN and Priority

Using getListenerRule

getListenerRule Result

Supporting Types

GetListenerRuleAction

GetListenerRuleActionAuthenticateCognito

GetListenerRuleActionAuthenticateOidc

GetListenerRuleActionFixedResponse

GetListenerRuleActionForward

GetListenerRuleActionForwardStickiness

GetListenerRuleActionForwardTargetGroup

GetListenerRuleActionRedirect

GetListenerRuleCondition

GetListenerRuleConditionHostHeader

GetListenerRuleConditionHttpHeader

GetListenerRuleConditionHttpRequestMethod

GetListenerRuleConditionPathPattern

GetListenerRuleConditionQueryString

GetListenerRuleConditionQueryStringValue

GetListenerRuleConditionSourceIp

Package Details

On this page

On this page