class BaseListener
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ElasticLoadBalancingV2.BaseListener |
Java | software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener |
Python | aws_cdk.aws_elasticloadbalancingv2.BaseListener |
TypeScript (source) | @aws-cdk/aws-elasticloadbalancingv2 » BaseListener |
Implements
IConstruct
, IConstruct
, IDependable
, IResource
Extends
Resource
Implemented by
Application
, Network
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 | Resource | The environment this resource belongs to. |
listener | string | |
node | Construct | The construct tree node associated with this construct. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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
node
Type:
Construct
The construct tree node associated with this construct.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
protected validate() | Validate this listener. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
protected validate()
protected validate(): string[]
Returns
string[]
Validate this listener.