BaseApplicationListenerRuleProps

class aws_cdk.aws_elasticloadbalancingv2.BaseApplicationListenerRuleProps(*, priority, action=None, conditions=None, target_groups=None)

Bases: object

Basic properties for defining a rule on a listener.

Parameters:
  • priority (Union[int, float]) – Priority of the rule. The rule with the lowest priority will be used for every request. Priorities must be unique.

  • action (Optional[ListenerAction]) – Action to perform when requests are received. Only one of action, fixedResponse, redirectResponse or targetGroups can be specified. Default: - No action

  • conditions (Optional[Sequence[ListenerCondition]]) – Rule applies if matches the conditions. Default: - No conditions.

  • target_groups (Optional[Sequence[IApplicationTargetGroup]]) – 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.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticloadbalancingv2 as elbv2

# application_target_group: elbv2.ApplicationTargetGroup
# listener_action: elbv2.ListenerAction
# listener_condition: elbv2.ListenerCondition

base_application_listener_rule_props = elbv2.BaseApplicationListenerRuleProps(
    priority=123,

    # the properties below are optional
    action=listener_action,
    conditions=[listener_condition],
    target_groups=[application_target_group]
)

Attributes

action

Action to perform when requests are received.

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

Default:
  • No action

conditions

Rule applies if matches the conditions.

Default:
  • No conditions.

See:

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

priority

Priority of the rule.

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

Priorities must be unique.

target_groups

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.