software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkLoadBalancer

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.elasticloadbalancingv2.BaseLoadBalancer

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkLoadBalancer

All Implemented Interfaces:

IConstruct, IDependable, IResource, IVpcEndpointServiceLoadBalancer, ILoadBalancerV2, INetworkLoadBalancer

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:26.366Z")
public class NetworkLoadBalancer
extends BaseLoadBalancer
implements INetworkLoadBalancer

Define a new network load balancer.

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	NetworkLoadBalancer.Builder A fluent builder for NetworkLoadBalancer.

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

INetworkLoadBalancer.Jsii$Default, INetworkLoadBalancer.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetworkLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)
	NetworkLoadBalancer(software.constructs.Construct scope, java.lang.String id, NetworkLoadBalancerProps props)

Method Summary

Modifier and Type	Method and Description
NetworkListener	addListener(java.lang.String id, BaseNetworkListenerProps props) Add a listener to this load balancer.
static INetworkLoadBalancer	fromLookup(software.constructs.Construct scope, java.lang.String id, NetworkLoadBalancerLookupOptions options) Looks up the network load balancer.
static INetworkLoadBalancer	fromNetworkLoadBalancerAttributes(software.constructs.Construct scope, java.lang.String id, NetworkLoadBalancerAttributes attrs)
Metric	metric(java.lang.String metricName) Return the given named metric for this Network Load Balancer.
Metric	metric(java.lang.String metricName, MetricOptions props) Return the given named metric for this Network Load Balancer.
Metric	metricActiveFlowCount() The total number of concurrent TCP flows (or connections) from clients to targets.
Metric	metricActiveFlowCount(MetricOptions props) The total number of concurrent TCP flows (or connections) from clients to targets.
Metric	metricConsumedLCUs() The number of load balancer capacity units (LCU) used by your load balancer.
Metric	metricConsumedLCUs(MetricOptions props) The number of load balancer capacity units (LCU) used by your load balancer.
Metric	metricHealthyHostCount() Deprecated. use ``NetworkTargetGroup.metricHealthyHostCount`` instead
Metric	metricHealthyHostCount(MetricOptions props) Deprecated. use ``NetworkTargetGroup.metricHealthyHostCount`` instead
Metric	metricNewFlowCount() The total number of new TCP flows (or connections) established from clients to targets in the time period.
Metric	metricNewFlowCount(MetricOptions props) The total number of new TCP flows (or connections) established from clients to targets in the time period.
Metric	metricProcessedBytes() The total number of bytes processed by the load balancer, including TCP/IP headers.
Metric	metricProcessedBytes(MetricOptions props) The total number of bytes processed by the load balancer, including TCP/IP headers.
Metric	metricTcpClientResetCount() The total number of reset (RST) packets sent from a client to a target.
Metric	metricTcpClientResetCount(MetricOptions props) The total number of reset (RST) packets sent from a client to a target.
Metric	metricTcpElbResetCount() The total number of reset (RST) packets generated by the load balancer.
Metric	metricTcpElbResetCount(MetricOptions props) The total number of reset (RST) packets generated by the load balancer.
Metric	metricTcpTargetResetCount() The total number of reset (RST) packets sent from a target to a client.
Metric	metricTcpTargetResetCount(MetricOptions props) The total number of reset (RST) packets sent from a target to a client.
Metric	metricUnHealthyHostCount() Deprecated. use ``NetworkTargetGroup.metricUnHealthyHostCount`` instead
Metric	metricUnHealthyHostCount(MetricOptions props) Deprecated. use ``NetworkTargetGroup.metricUnHealthyHostCount`` instead

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

getLoadBalancerArn, getLoadBalancerCanonicalHostedZoneId, getLoadBalancerDnsName, getLoadBalancerFullName, getLoadBalancerName, getLoadBalancerSecurityGroups, getVpc, logAccessLogs, logAccessLogs, removeAttribute, setAttribute, setAttribute, 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.INetworkLoadBalancer

getVpc

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

getLoadBalancerCanonicalHostedZoneId, getLoadBalancerDnsName

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.awscdk.services.ec2.IVpcEndpointServiceLoadBalancer

getLoadBalancerArn

Constructor Detail

NetworkLoadBalancer

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

NetworkLoadBalancer

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

NetworkLoadBalancer

public NetworkLoadBalancer(software.constructs.Construct scope,
                           java.lang.String id,
                           NetworkLoadBalancerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromLookup

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

Looks up the network load balancer.

Parameters:

scope - This parameter is required.

id - This parameter is required.

options - This parameter is required.

fromNetworkLoadBalancerAttributes

public static INetworkLoadBalancer fromNetworkLoadBalancerAttributes(software.constructs.Construct scope,
                                                                     java.lang.String id,
                                                                     NetworkLoadBalancerAttributes attrs)

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addListener

public NetworkListener addListener(java.lang.String id,
                                   BaseNetworkListenerProps props)

Add a listener to this load balancer.

Specified by:

addListener in interface INetworkLoadBalancer

Parameters:

id - This parameter is required.

props - This parameter is required.

Returns:

The newly created listener

metric

public Metric metric(java.lang.String metricName,
                     MetricOptions props)

Return the given named metric for this Network Load Balancer.

Default: Average over 5 minutes

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

Return the given named metric for this Network Load Balancer.

Default: Average over 5 minutes

Parameters:

metricName - This parameter is required.

metricActiveFlowCount

public Metric metricActiveFlowCount(MetricOptions props)

The total number of concurrent TCP flows (or connections) from clients to targets.

This metric includes connections in the SYN_SENT and ESTABLISHED states. TCP connections are not terminated at the load balancer, so a client opening a TCP connection to a target counts as a single flow.

Default: Average over 5 minutes

Parameters:

props -

metricActiveFlowCount

public Metric metricActiveFlowCount()

The total number of concurrent TCP flows (or connections) from clients to targets.

This metric includes connections in the SYN_SENT and ESTABLISHED states. TCP connections are not terminated at the load balancer, so a client opening a TCP connection to a target counts as a single flow.

Default: Average over 5 minutes

metricConsumedLCUs

public Metric metricConsumedLCUs(MetricOptions props)

The number of load balancer capacity units (LCU) used by your load balancer.

Default: Sum over 5 minutes

Parameters:

props -

metricConsumedLCUs

public Metric metricConsumedLCUs()

The number of load balancer capacity units (LCU) used by your load balancer.

Default: Sum over 5 minutes

metricHealthyHostCount

@Deprecated
public Metric metricHealthyHostCount(MetricOptions props)

Deprecated. use ``NetworkTargetGroup.metricHealthyHostCount`` instead

(deprecated) The number of targets that are considered healthy.

Default: Average over 5 minutes

Parameters:

props -

metricHealthyHostCount

@Deprecated
public Metric metricHealthyHostCount()

Deprecated. use ``NetworkTargetGroup.metricHealthyHostCount`` instead

(deprecated) The number of targets that are considered healthy.

Default: Average over 5 minutes

metricNewFlowCount

public Metric metricNewFlowCount(MetricOptions props)

The total number of new TCP flows (or connections) established from clients to targets in the time period.

Default: Sum over 5 minutes

Parameters:

props -

metricNewFlowCount

public Metric metricNewFlowCount()

The total number of new TCP flows (or connections) established from clients to targets in the time period.

Default: Sum over 5 minutes

metricProcessedBytes

public Metric metricProcessedBytes(MetricOptions props)

The total number of bytes processed by the load balancer, including TCP/IP headers.

Default: Sum over 5 minutes

Parameters:

props -

metricProcessedBytes

public Metric metricProcessedBytes()

The total number of bytes processed by the load balancer, including TCP/IP headers.

Default: Sum over 5 minutes

metricTcpClientResetCount

public Metric metricTcpClientResetCount(MetricOptions props)

The total number of reset (RST) packets sent from a client to a target.

These resets are generated by the client and forwarded by the load balancer.

Default: Sum over 5 minutes

Parameters:

props -

metricTcpClientResetCount

public Metric metricTcpClientResetCount()

The total number of reset (RST) packets sent from a client to a target.

These resets are generated by the client and forwarded by the load balancer.

Default: Sum over 5 minutes

metricTcpElbResetCount

public Metric metricTcpElbResetCount(MetricOptions props)

The total number of reset (RST) packets generated by the load balancer.

Default: Sum over 5 minutes

Parameters:

props -

metricTcpElbResetCount

public Metric metricTcpElbResetCount()

The total number of reset (RST) packets generated by the load balancer.

Default: Sum over 5 minutes

metricTcpTargetResetCount

public Metric metricTcpTargetResetCount(MetricOptions props)

The total number of reset (RST) packets sent from a target to a client.

These resets are generated by the target and forwarded by the load balancer.

Default: Sum over 5 minutes

Parameters:

props -

metricTcpTargetResetCount

public Metric metricTcpTargetResetCount()

The total number of reset (RST) packets sent from a target to a client.

These resets are generated by the target and forwarded by the load balancer.

Default: Sum over 5 minutes

metricUnHealthyHostCount

@Deprecated
public Metric metricUnHealthyHostCount(MetricOptions props)

Deprecated. use ``NetworkTargetGroup.metricUnHealthyHostCount`` instead

(deprecated) The number of targets that are considered unhealthy.

Default: Average over 5 minutes

Parameters:

props -

metricUnHealthyHostCount

@Deprecated
public Metric metricUnHealthyHostCount()

Deprecated. use ``NetworkTargetGroup.metricUnHealthyHostCount`` instead

(deprecated) The number of targets that are considered unhealthy.

Default: Average over 5 minutes