software.amazon.awscdk.services.elasticloadbalancingv2

Interface BaseApplicationListenerRuleProps

All Known Subinterfaces:

ApplicationListenerRuleProps

All Known Implementing Classes:

ApplicationListenerRuleProps.Jsii$Proxy, BaseApplicationListenerRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.533Z")
public interface BaseApplicationListenerRuleProps

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))
         .fixedResponse(FixedResponse.builder()
                 .statusCode("statusCode")
                 // the properties below are optional
                 .contentType(ContentType.TEXT_PLAIN)
                 .messageBody("messageBody")
                 .build())
         .hostHeader("hostHeader")
         .pathPattern("pathPattern")
         .pathPatterns(List.of("pathPatterns"))
         .redirectResponse(RedirectResponse.builder()
                 .statusCode("statusCode")
                 // the properties below are optional
                 .host("host")
                 .path("path")
                 .port("port")
                 .protocol("protocol")
                 .query("query")
                 .build())
         .targetGroups(List.of(applicationTargetGroup))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BaseApplicationListenerRuleProps.Builder	builder()
default ListenerAction	getAction() Action to perform when requests are received.
default java.util.List<ListenerCondition>	getConditions() Rule applies if matches the conditions.
default FixedResponse	getFixedResponse() Deprecated. Use `action` instead.
default java.lang.String	getHostHeader() Deprecated. Use `conditions` instead.
default java.lang.String	getPathPattern() Deprecated. Use `conditions` instead.
default java.util.List<java.lang.String>	getPathPatterns() Deprecated. Use `conditions` instead.
java.lang.Number	getPriority() Priority of the rule.
default RedirectResponse	getRedirectResponse() Deprecated. Use `action` instead.
default java.util.List<IApplicationTargetGroup>	getTargetGroups() Target groups to forward requests to.

Method Detail

getPriority

java.lang.Number getPriority()

Priority of the rule.

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

Priorities must be unique.

getAction

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

default java.util.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

getFixedResponse

@Deprecated
default FixedResponse getFixedResponse()

Deprecated. Use `action` instead.

(deprecated) Fixed response to return.

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

Default: - No fixed response.

getHostHeader

@Deprecated
default java.lang.String getHostHeader()

Deprecated. Use `conditions` instead.

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

May contain up to three '*' wildcards.

Default: - No host condition.

See Also:

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

getPathPattern

@Deprecated
default java.lang.String getPathPattern()

Deprecated. Use `conditions` instead.

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

Default: - No path condition.

See Also:

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

getPathPatterns

@Deprecated
default java.util.List<java.lang.String> getPathPatterns()

Deprecated. Use `conditions` instead.

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

Paths may contain up to three '*' wildcards.

Default: - No path conditions.

See Also:

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

getRedirectResponse

@Deprecated
default RedirectResponse getRedirectResponse()

Deprecated. Use `action` instead.

(deprecated) Redirect response to return.

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

Default: - No redirect response.

getTargetGroups

default java.util.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

static BaseApplicationListenerRuleProps.Builder builder()

Returns:

a BaseApplicationListenerRuleProps.Builder of BaseApplicationListenerRuleProps