aws-cdk-lib.aws_elasticloadbalancingv2.BaseApplicationListenerRuleProps

interface BaseApplicationListenerRuleProps

LanguageType name
.NETAmazon.CDK.AWS.ElasticLoadBalancingV2.BaseApplicationListenerRuleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#BaseApplicationListenerRuleProps
Javasoftware.amazon.awscdk.services.elasticloadbalancingv2.BaseApplicationListenerRuleProps
Pythonaws_cdk.aws_elasticloadbalancingv2.BaseApplicationListenerRuleProps
TypeScript (source)aws-cdk-lib » aws_elasticloadbalancingv2 » 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 { 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

NameTypeDescription
prioritynumberPriority of the rule.
action?ListenerActionAction to perform when requests are received.
conditions?ListenerCondition[]Rule applies if matches the conditions.
targetGroups?IApplicationTargetGroup[]Target groups to forward requests to.

priority

Type: number

Priority of the rule.

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

Priorities must be unique.


action?

Type: ListenerAction (optional, default: No action)

Action to perform when requests are received.

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


conditions?

Type: ListenerCondition[] (optional, default: No conditions.)

Rule applies if matches the conditions.

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


targetGroups?

Type: IApplicationTargetGroup[] (optional, default: No target groups.)

Target groups to forward requests to.

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

Implies a forward action.