Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface BaseApplicationListenerRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ApplicationListenerRuleProps

All Known Implementing Classes:

ApplicationListenerRuleProps.Jsii$Proxy, BaseApplicationListenerRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-04T12:43:07.114Z")
@Stability(Stable)
public interface BaseApplicationListenerRuleProps
extends software.amazon.jsii.JsiiSerializable

Basic properties for defining a rule on a listener.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 ApplicationTargetGroup applicationTargetGroup;
 ListenerAction listenerAction;
 ListenerCondition listenerCondition;
 BaseApplicationListenerRuleProps baseApplicationListenerRuleProps = BaseApplicationListenerRuleProps.builder()
         .priority(123)
         // the properties below are optional
         .action(listenerAction)
         .conditions(List.of(listenerCondition))
         .targetGroups(List.of(applicationTargetGroup))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BaseApplicationListenerRuleProps.Builder	A builder for BaseApplicationListenerRuleProps
static final class	BaseApplicationListenerRuleProps.Jsii$Proxy	An implementation for BaseApplicationListenerRuleProps

Method Summary

Modifier and Type	Method	Description
static BaseApplicationListenerRuleProps.Builder	builder()
default ListenerAction	getAction()	Action to perform when requests are received.
default List<ListenerCondition>	getConditions()	Rule applies if matches the conditions.
Number	getPriority()	Priority of the rule.
default List<IApplicationTargetGroup>	getTargetGroups()	Target groups to forward requests to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPriority

@Stability(Stable)
@NotNull
Number getPriority()

Priority of the rule.

The rule with the lowest priority will be used for every request.

Priorities must be unique.

getAction

@Stability(Stable)
@Nullable
default ListenerAction getAction()

Action to perform when requests are received.

Only one of action, fixedResponse, redirectResponse or targetGroups can be specified.

Default: - No action

getConditions

@Stability(Stable)
@Nullable
default List<ListenerCondition> getConditions()

Rule applies if matches the conditions.

Default: - No conditions.

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html

getTargetGroups

@Stability(Stable)
@Nullable
default List<IApplicationTargetGroup> getTargetGroups()

Target groups to forward requests to.

Only one of action, fixedResponse, redirectResponse or targetGroups can be specified.

Implies a forward action.

Default: - No target groups.

builder

@Stability(Stable)
static BaseApplicationListenerRuleProps.Builder builder()

Returns:

a BaseApplicationListenerRuleProps.Builder of BaseApplicationListenerRuleProps