class ApplicationListenerRule (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ElasticLoadBalancingV2.ApplicationListenerRule
Java	software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerRule
Python	aws_cdk.aws_elasticloadbalancingv2.ApplicationListenerRule
TypeScript (source)	@aws-cdk/aws-elasticloadbalancingv2 » ApplicationListenerRule

Implements IConstruct, IConstruct, IDependable

Define a new listener rule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';

declare const applicationListener: elbv2.ApplicationListener;
declare const applicationTargetGroup: elbv2.ApplicationTargetGroup;
declare const listenerAction: elbv2.ListenerAction;
declare const listenerCondition: elbv2.ListenerCondition;
const applicationListenerRule = new elbv2.ApplicationListenerRule(this, 'MyApplicationListenerRule', {
  listener: applicationListener,
  priority: 123,

  // the properties below are optional
  action: listenerAction,
  conditions: [listenerCondition],
  fixedResponse: {
    statusCode: 'statusCode',

    // the properties below are optional
    contentType: elbv2.ContentType.TEXT_PLAIN,
    messageBody: 'messageBody',
  },
  hostHeader: 'hostHeader',
  pathPattern: 'pathPattern',
  pathPatterns: ['pathPatterns'],
  redirectResponse: {
    statusCode: 'statusCode',

    // the properties below are optional
    host: 'host',
    path: 'path',
    port: 'port',
    protocol: 'protocol',
    query: 'query',
  },
  targetGroups: [applicationTargetGroup],
});

Initializer

new ApplicationListenerRule(scope: Construct, id: string, props: ApplicationListenerRuleProps)

Parameters

• scope Construct
• id string
• props ApplicationListenerRuleProps

Construct Props

Name	Type	Description
listener	IApplicationListener	The listener to attach the rule to.
priority	number	Priority of the rule.
action?	ListenerAction	Action to perform when requests are received.
conditions?	ListenerCondition[]	Rule applies if matches the conditions.
fixedResponse?⚠️	FixedResponse	Fixed response to return.
hostHeader?⚠️	string	Rule applies if the requested host matches the indicated host.
pathPattern?⚠️	string	Rule applies if the requested path matches the given path pattern.
pathPatterns?⚠️	string[]	Rule applies if the requested path matches any of the given patterns.
redirectResponse?⚠️	RedirectResponse	Redirect response to return.
targetGroups?	IApplicationTargetGroup[]	Target groups to forward requests to.

---

listener

Type: IApplicationListener

The listener to attach the rule 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

---

fixedResponse?⚠️

⚠️ Deprecated: Use action instead.

Type: FixedResponse (optional, default: No fixed response.)

Fixed response to return.

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

---

hostHeader?⚠️

⚠️ Deprecated: Use conditions instead.

Type: string (optional, default: No host condition.)

Rule applies if the requested host matches the indicated host.

May contain up to three '*' wildcards.

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

---

pathPattern?⚠️

⚠️ Deprecated: Use conditions instead.

Type: string (optional, default: No path condition.)

Rule applies if the requested path matches the given path pattern.

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

---

pathPatterns?⚠️

⚠️ Deprecated: Use conditions instead.

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

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

Paths may contain up to three '*' wildcards.

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

---

redirectResponse?⚠️

⚠️ Deprecated: Use action instead.

Type: RedirectResponse (optional, default: No redirect response.)

Redirect response to return.

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

---

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.

Properties

Name	Type	Description
listenerRuleArn	string	The ARN of this rule.
node	ConstructNode	The construct tree node associated with this construct.

---

listenerRuleArn

Type: string

The ARN of this rule.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

Methods

Name	Description
addCondition(condition)	Add a non-standard condition to this rule.
addFixedResponse(fixedResponse)⚠️	Add a fixed response.
addRedirectResponse(redirectResponse)⚠️	Add a redirect response.
addTargetGroup(targetGroup)⚠️	Add a TargetGroup to load balance to.
configureAction(action)	Configure the action to perform for this rule.
setCondition(field, values?)⚠️	Add a non-standard condition to this rule.
toString()	Returns a string representation of this construct.
protected validate()	Validate the rule.

---

addCondition(condition)

public addCondition(condition: ListenerCondition): void

Parameters

• condition ListenerCondition

Add a non-standard condition to this rule.

---

addFixedResponse(fixedResponse)⚠️

public addFixedResponse(fixedResponse: FixedResponse): void

⚠️ Deprecated: Use configureAction instead

Parameters

• fixedResponse FixedResponse

Add a fixed response.

---

addRedirectResponse(redirectResponse)⚠️

public addRedirectResponse(redirectResponse: RedirectResponse): void

⚠️ Deprecated: Use configureAction instead

Parameters

• redirectResponse RedirectResponse

Add a redirect response.

---

addTargetGroup(targetGroup)⚠️

public addTargetGroup(targetGroup: IApplicationTargetGroup): void

⚠️ Deprecated: Use configureAction instead

Parameters

• targetGroup IApplicationTargetGroup

Add a TargetGroup to load balance to.

---

configureAction(action)

public configureAction(action: ListenerAction): void

Parameters

• action ListenerAction

Configure the action to perform for this rule.

---

setCondition(field, values?)⚠️

public setCondition(field: string, values?: string[]): void

⚠️ Deprecated: use addCondition instead.

Parameters

• field string
• values string[]

Add a non-standard condition to this rule.

If the condition conflicts with an already set condition, it will be overwritten by the one you specified.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected validate()

protected validate(): string[]

Returns

• string[]

Validate the rule.