Skip to content
v2.274.0

BaseApplicationListenerRuleProps Struct ​

Basic properties for defining a rule on a listener.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';

declare const applicationTargetGroup: elbv2.ApplicationTargetGroup;
declare const listenerAction: elbv2.ListenerAction;
declare const listenerCondition: elbv2.ListenerCondition;
const baseApplicationListenerRuleProps: elbv2.BaseApplicationListenerRuleProps = {
  priority: 123,

  // the properties below are optional
  action: listenerAction,
  conditions: [listenerCondition],
  targetGroups: [applicationTargetGroup],
};

Properties ​

Action to perform when requests are received.

Default: No action

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

conditionsListenerCondition[]conditionstyping.List[ListenerCondition]conditionsList<ListenerCondition>ConditionsListenerCondition[]Conditions*[]ListenerCondition#
Rule applies if matches the conditions.

Default: No conditions.

prioritynumberpriorityint | floatpriorityNumberPrioritydoublePriority*float64required#
Priority of the rule.

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

Priorities must be unique.

targetGroupsIApplicationTargetGroup[]target_groupstyping.List[IApplicationTargetGroup]targetGroupsList<IApplicationTargetGroup>TargetGroupsIApplicationTargetGroup[]TargetGroups*[]IApplicationTargetGroup#
Target groups to forward requests to.

Default: No target groups.

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

Implies a forward action.