software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkListener

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkListener

All Implemented Interfaces:

IResource, INetworkListener, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:29.972Z")
 @Stability(value=Experimental)
public class NetworkListener
extends BaseListener
implements INetworkListener

(experimental) Define a Network Listener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkListener.Builder (experimental) A fluent builder for NetworkListener.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

INetworkListener.Jsii$Default, INetworkListener.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	NetworkListener(software.constructs.Construct scope, String id, NetworkListenerProps props)
protected	NetworkListener(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkListener(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addAction(String _id, AddNetworkActionProps props) (experimental) Perform the given Action on incoming requests.
void	addTargetGroups(String _id, INetworkTargetGroup... targetGroups) (experimental) Load balance incoming requests to the given target groups.
NetworkTargetGroup	addTargets(String id, AddNetworkTargetsProps props) (experimental) Load balance incoming requests to the given load balancing targets.
static INetworkListener	fromLookup(software.constructs.Construct scope, String id, NetworkListenerLookupOptions options) (experimental) Looks up a network listener.
static INetworkListener	fromNetworkListenerArn(software.constructs.Construct scope, String id, String networkListenerArn) (experimental) Import an existing listener.
INetworkLoadBalancer	getLoadBalancer() (experimental) The load balancer this listener is attached to.

Methods inherited from class software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener

getListenerArn, validateListener

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.INetworkListener

getListenerArn

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

NetworkListener

protected NetworkListener(software.amazon.jsii.JsiiObjectRef objRef)

NetworkListener

protected NetworkListener(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

NetworkListener

@Stability(value=Experimental)
public NetworkListener(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      NetworkListenerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromLookup

@Stability(value=Experimental)
 @NotNull
public static INetworkListener fromLookup(@NotNull
                                                                                   software.constructs.Construct scope,
                                                                                   @NotNull
                                                                                   String id,
                                                                                   @NotNull
                                                                                   NetworkListenerLookupOptions options)

(experimental) Looks up a network listener.

Parameters:

scope - This parameter is required.

id - This parameter is required.

options - This parameter is required.

fromNetworkListenerArn

@Stability(value=Experimental)
 @NotNull
public static INetworkListener fromNetworkListenerArn(@NotNull
                                                                                               software.constructs.Construct scope,
                                                                                               @NotNull
                                                                                               String id,
                                                                                               @NotNull
                                                                                               String networkListenerArn)

(experimental) Import an existing listener.

Parameters:

scope - This parameter is required.

id - This parameter is required.

networkListenerArn - This parameter is required.

addAction

@Stability(value=Experimental)
public void addAction(@NotNull
                                                     String _id,
                                                     @NotNull
                                                     AddNetworkActionProps props)

(experimental) Perform the given Action on incoming requests.

This allows full control of the default Action of the load balancer, including weighted forwarding. See the NetworkListenerAction class for all options.

Parameters:

_id - This parameter is required.

props - This parameter is required.

addTargetGroups

@Stability(value=Experimental)
public void addTargetGroups(@NotNull
                                                           String _id,
                                                           @NotNull
                                                           INetworkTargetGroup... targetGroups)

(experimental) Load balance incoming requests to the given target groups.

All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use addAction().

Parameters:

_id - This parameter is required.

targetGroups - This parameter is required.

addTargets

@Stability(value=Experimental)
 @NotNull
public NetworkTargetGroup addTargets(@NotNull
                                                                              String id,
                                                                              @NotNull
                                                                              AddNetworkTargetsProps props)

(experimental) Load balance incoming requests to the given load balancing targets.

This method implicitly creates a NetworkTargetGroup for the targets involved, and a 'forward' action to route traffic to the given TargetGroup.

If you want more control over the precise setup, create the TargetGroup and use addAction yourself.

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

Parameters:

id - This parameter is required.

props - This parameter is required.

Returns:

The newly created target group

getLoadBalancer

@Stability(value=Experimental)
 @NotNull
public INetworkLoadBalancer getLoadBalancer()

(experimental) The load balancer this listener is attached to.