software.amazon.awscdk.services.elasticloadbalancingv2

Interface IApplicationListener.Jsii$Default

All Superinterfaces:

IApplicationListener, IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IApplicationListener.Jsii$Proxy

Enclosing interface:

IApplicationListener

@Internal
public static interface IApplicationListener.Jsii$Default
extends IApplicationListener, IResource.Jsii$Default, IConnectable.Jsii$Default

Internal default implementation for IApplicationListener.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationListener

IApplicationListener.Jsii$Default, IApplicationListener.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	addAction(String id, AddApplicationActionProps props) Perform the given action on incoming requests.
default void	addCertificates(String id, List<IListenerCertificate> certificates) Add one or more certificates to this listener.
default void	addTargetGroups(String id, AddApplicationTargetGroupsProps props) Load balance incoming requests to the given target groups.
default ApplicationTargetGroup	addTargets(String id, AddApplicationTargetsProps props) Load balance incoming requests to the given load balancing targets.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default Connections	getConnections() The network connections associated with this resource.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default String	getListenerArn() ARN of the listener.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default void	registerConnectable(IConnectable connectable, Port portRange) Register that a connectable that has been added to this load balancer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(value=Stable)
 @NotNull
default Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getListenerArn

@Stability(value=Stable)
 @NotNull
default String getListenerArn()

ARN of the listener.

Specified by:

getListenerArn in interface IApplicationListener

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addAction

@Stability(value=Stable)
default void addAction(@NotNull
                                                String id,
                                                @NotNull
                                                AddApplicationActionProps props)

Perform the given action on incoming requests.

This allows full control of the default action of the load balancer, including Action chaining, fixed responses and redirect responses. See the ListenerAction class for all options.

It's possible to add routing conditions to the Action added in this way.

It is not possible to add a default action to an imported IApplicationListener. In order to add actions to an imported IApplicationListener a priority must be provided.

Specified by:

addAction in interface IApplicationListener

Parameters:

id - This parameter is required.

props - This parameter is required.

addCertificates

@Stability(value=Stable)
default void addCertificates(@NotNull
                                                      String id,
                                                      @NotNull
                                                      List<IListenerCertificate> certificates)

Add one or more certificates to this listener.

Specified by:

addCertificates in interface IApplicationListener

Parameters:

id - This parameter is required.

certificates - This parameter is required.

addTargetGroups

@Stability(value=Stable)
default void addTargetGroups(@NotNull
                                                      String id,
                                                      @NotNull
                                                      AddApplicationTargetGroupsProps props)

Load balance incoming requests to the given target groups.

It's possible to add conditions to the TargetGroups added in this way. At least one TargetGroup must be added without conditions.

Specified by:

addTargetGroups in interface IApplicationListener

Parameters:

id - This parameter is required.

props - This parameter is required.

addTargets

@Stability(value=Stable)
 @NotNull
default ApplicationTargetGroup addTargets(@NotNull
                                                                             String id,
                                                                             @NotNull
                                                                             AddApplicationTargetsProps props)

Load balance incoming requests to the given load balancing targets.

This method implicitly creates an ApplicationTargetGroup for the targets involved.

It's possible to add conditions to the targets added in this way. At least one set of targets must be added without conditions.

Specified by:

addTargets in interface IApplicationListener

Parameters:

id - This parameter is required.

props - This parameter is required.

Returns:

The newly created target group

registerConnectable

@Stability(value=Stable)
default void registerConnectable(@NotNull
                                                          IConnectable connectable,
                                                          @NotNull
                                                          Port portRange)

Register that a connectable that has been added to this load balancer.

Don't call this directly. It is called by ApplicationTargetGroup.

Specified by:

registerConnectable in interface IApplicationListener

Parameters:

connectable - This parameter is required.

portRange - This parameter is required.