Package software.amazon.awscdk.services.elasticloadbalancingv2

Class ApplicationListenerRule.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationListenerRule>

Enclosing class:

ApplicationListenerRule

@Stability(Stable)
public static final class ApplicationListenerRule.Builder
extends Object
implements software.amazon.jsii.Builder<ApplicationListenerRule>

A fluent builder for ApplicationListenerRule.

Method Summary

Modifier and Type	Method	Description
ApplicationListenerRule.Builder	action(ListenerAction action)	Action to perform when requests are received.
ApplicationListenerRule	build()
ApplicationListenerRule.Builder	conditions(List<? extends ListenerCondition> conditions)	Rule applies if matches the conditions.
static ApplicationListenerRule.Builder	create(software.constructs.Construct scope, String id)
ApplicationListenerRule.Builder	listener(IApplicationListener listener)	The listener to attach the rule to.
ApplicationListenerRule.Builder	priority(Number priority)	Priority of the rule.
ApplicationListenerRule.Builder	targetGroups(List<? extends IApplicationTargetGroup> targetGroups)	Target groups to forward requests to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static ApplicationListenerRule.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ApplicationListenerRule.Builder.

priority

@Stability(Stable)
public ApplicationListenerRule.Builder priority(Number priority)

Priority of the rule.

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

Priorities must be unique.

Parameters:

priority - Priority of the rule. This parameter is required.

Returns:

this

action

@Stability(Stable)
public ApplicationListenerRule.Builder action(ListenerAction action)

Action to perform when requests are received.

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

Default: - No action

Parameters:

action - Action to perform when requests are received. This parameter is required.

Returns:

this

conditions

@Stability(Stable)
public ApplicationListenerRule.Builder conditions(List<? extends ListenerCondition> conditions)

Rule applies if matches the conditions.

Default: - No conditions.

Parameters:

conditions - Rule applies if matches the conditions. This parameter is required.

Returns:

this

See Also:

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

targetGroups

@Stability(Stable)
public ApplicationListenerRule.Builder targetGroups(List<? extends IApplicationTargetGroup> targetGroups)

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.

Parameters:

targetGroups - Target groups to forward requests to. This parameter is required.

Returns:

this

listener

@Stability(Stable)
public ApplicationListenerRule.Builder listener(IApplicationListener listener)

The listener to attach the rule to.

Parameters:

listener - The listener to attach the rule to. This parameter is required.

Returns:

this

build

@Stability(Stable)
public ApplicationListenerRule build()

Specified by:

build in interface software.amazon.jsii.Builder<ApplicationListenerRule>

Returns:

a newly built instance of ApplicationListenerRule.