aws-cdk-lib.aws_elasticloadbalancingv2.BaseListener

class BaseListener

LanguageType name
.NETAmazon.CDK.AWS.ElasticLoadBalancingV2.BaseListener
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#BaseListener
Javasoftware.amazon.awscdk.services.elasticloadbalancingv2.BaseListener
Pythonaws_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

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
listenerArnstringARN of the listener.
nodeNodeThe tree node.
stackStackThe 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

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
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).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected validateListener()

protected validateListener(): string[]

Returns

  • string[]

Validate this listener.