software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkListener

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkListener

All Implemented Interfaces:

IConstruct, IDependable, IResource, INetworkListener

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.143Z")
public class NetworkListener
extends BaseListener
implements INetworkListener

Define a Network Listener.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpNlbIntegration;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer lb = NetworkLoadBalancer.Builder.create(this, "lb").vpc(vpc).build();
 NetworkListener listener = lb.addListener("listener", BaseNetworkListenerProps.builder().port(80).build());
 listener.addTargets("target", AddNetworkTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(new HttpNlbIntegration("DefaultIntegration", listener))
         .build();
 

Nested Class Summary

Nested Classes

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

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
protected	NetworkListener(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkListener(software.amazon.jsii.JsiiObjectRef objRef)
	NetworkListener(software.constructs.Construct scope, java.lang.String id, NetworkListenerProps props)

Method Summary

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

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

getListenerArn, validate

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

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

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

getListenerArn

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

NetworkListener

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

NetworkListener

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

NetworkListener

public NetworkListener(software.constructs.Construct scope,
                       java.lang.String id,
                       NetworkListenerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromLookup

public static INetworkListener fromLookup(software.constructs.Construct scope,
                                          java.lang.String id,
                                          NetworkListenerLookupOptions options)

Looks up a network listener.

Parameters:

scope - This parameter is required.

id - This parameter is required.

options - This parameter is required.

fromNetworkListenerArn

public static INetworkListener fromNetworkListenerArn(software.constructs.Construct scope,
                                                      java.lang.String id,
                                                      java.lang.String networkListenerArn)

Import an existing listener.

Parameters:

scope - This parameter is required.

id - This parameter is required.

networkListenerArn - This parameter is required.

addAction

public void addAction(java.lang.String _id,
                      AddNetworkActionProps props)

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.

addCertificates

public void addCertificates(java.lang.String id,
                            java.util.List<IListenerCertificate> certificates)

Add one or more certificates to this listener.

After the first certificate, this creates NetworkListenerCertificates resources since cloudformation requires the certificates array on the listener resource to have a length of 1.

Parameters:

id - This parameter is required.

certificates - This parameter is required.

addTargetGroups

public void addTargetGroups(java.lang.String _id,
                            INetworkTargetGroup... targetGroups)

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

public NetworkTargetGroup addTargets(java.lang.String id,
                                     AddNetworkTargetsProps props)

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

public INetworkLoadBalancer getLoadBalancer()

The load balancer this listener is attached to.