Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface AddRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AddApplicationActionProps, AddApplicationTargetGroupsProps, AddApplicationTargetsProps, AddFixedResponseProps, AddRedirectResponseProps

All Known Implementing Classes:

AddApplicationActionProps.Jsii$Proxy, AddApplicationTargetGroupsProps.Jsii$Proxy, AddApplicationTargetsProps.Jsii$Proxy, AddFixedResponseProps.Jsii$Proxy, AddRedirectResponseProps.Jsii$Proxy, AddRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.165Z")
@Stability(Stable)
public interface AddRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for adding a conditional load balancing rule.

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.*;
 ListenerCondition listenerCondition;
 AddRuleProps addRuleProps = AddRuleProps.builder()
         .conditions(List.of(listenerCondition))
         .hostHeader("hostHeader")
         .pathPattern("pathPattern")
         .pathPatterns(List.of("pathPatterns"))
         .priority(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AddRuleProps.Builder	builder()
default List<ListenerCondition>	getConditions()	Rule applies if matches the conditions.
default String	getHostHeader()	Deprecated. Use conditions instead.
default String	getPathPattern()	Deprecated. Use conditions instead.
default List<String>	getPathPatterns()	Deprecated. Use conditions instead.
default Number	getPriority()	Priority of this target group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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

getHostHeader

@Stability(Deprecated)
@Deprecated
@Nullable
default String getHostHeader()

Deprecated.

Use conditions instead.

(deprecated) Rule applies if the requested host matches the indicated host.

May contain up to three '*' wildcards.

Requires that priority is set.

Default: No host condition

See Also:

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

getPathPattern

@Stability(Deprecated)
@Deprecated
@Nullable
default String getPathPattern()

Deprecated.

Use conditions instead.

(deprecated) Rule applies if the requested path matches the given path pattern.

May contain up to three '*' wildcards.

Requires that priority is set.

Default: No path condition

See Also:

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

getPathPatterns

@Stability(Deprecated)
@Deprecated
@Nullable
default List<String> getPathPatterns()

Deprecated.

Use conditions instead.

(deprecated) Rule applies if the requested path matches any of the given patterns.

May contain up to three '*' wildcards.

Requires that priority is set.

Default: - No path condition.

See Also:

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

getPriority

@Stability(Stable)
@Nullable
default Number getPriority()

Priority of this target group.

The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions.

Priorities must be unique.

Default: Target groups are used as defaults

builder

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

Returns:

a AddRuleProps.Builder of AddRuleProps