class BaseListener

Language	Type name
.NET	Amazon.CDK.AWS.ElasticLoadBalancingV2.BaseListener
Go	github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#BaseListener
Java	software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener
Python	aws_cdk.aws_elasticloadbalancingv2.BaseListener
TypeScript (source)	aws-cdk-lib » aws_elasticloadbalancingv2 » BaseListener

Implements IConstruct, IDependable, IResource, IListener

Extends Resource

Implemented by ApplicationListener, NetworkListener

Base class for listeners.

Initializer

new BaseListener(scope: Construct, id: string, additionalProps: any)

Parameters

• scope Construct
• id string
• additionalProps any

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
listenerArn	string	ARN of the listener.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

listenerArn

Type: string

ARN of the listener.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
removeAttribute(key)	Remove an attribute from the listener.
setAttribute(key, value?)	Set a non-standard attribute on the listener.
toString()	Returns a string representation of this construct.
protected validateListener()	Validate this listener.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

removeAttribute(key)

public removeAttribute(key: string): void

Parameters

• key string

Remove an attribute from the listener.

---

setAttribute(key, value?)

public setAttribute(key: string, value?: string): void

Parameters

• key string
• value string

Set a non-standard attribute on the listener.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-listenerattribute.html

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected validateListener()

protected validateListener(): string[]

Returns

• string[]

Validate this listener.