software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkLoadBalancer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.elasticloadbalancingv2.BaseLoadBalancer

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkLoadBalancer

All Implemented Interfaces:

IResource, IVpcEndpointServiceLoadBalancer, ILoadBalancerV2, INetworkLoadBalancer, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.127Z")
 @Stability(value=Stable)
public class NetworkLoadBalancer
extends BaseLoadBalancer
implements INetworkLoadBalancer

Define a new network load balancer.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.alpha.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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

Method Summary

Modifier and Type	Method and Description
NetworkListener	addListener(String id, BaseNetworkListenerProps props) Add a listener to this load balancer.
static INetworkLoadBalancer	fromLookup(software.constructs.Construct scope, String id, NetworkLoadBalancerLookupOptions options) Looks up the network load balancer.
static INetworkLoadBalancer	fromNetworkLoadBalancerAttributes(software.constructs.Construct scope, String id, NetworkLoadBalancerAttributes attrs)
Metric	metric(String metricName) Return the given named metric for this Network Load Balancer.
Metric	metric(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	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.

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

getLoadBalancerArn, getLoadBalancerCanonicalHostedZoneId, getLoadBalancerDnsName, getLoadBalancerFullName, getLoadBalancerName, getLoadBalancerSecurityGroups, getVpc, logAccessLogs, logAccessLogs, removeAttribute, setAttribute, setAttribute, validateLoadBalancer

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, 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.INetworkLoadBalancer

getVpc

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

getLoadBalancerCanonicalHostedZoneId, getLoadBalancerDnsName

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

@Stability(value=Stable)
public NetworkLoadBalancer(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    NetworkLoadBalancerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromLookup

@Stability(value=Stable)
 @NotNull
public static INetworkLoadBalancer fromLookup(@NotNull
                                                                                 software.constructs.Construct scope,
                                                                                 @NotNull
                                                                                 String id,
                                                                                 @NotNull
                                                                                 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

@Stability(value=Stable)
 @NotNull
public static INetworkLoadBalancer fromNetworkLoadBalancerAttributes(@NotNull
                                                                                                        software.constructs.Construct scope,
                                                                                                        @NotNull
                                                                                                        String id,
                                                                                                        @NotNull
                                                                                                        NetworkLoadBalancerAttributes attrs)

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addListener

@Stability(value=Stable)
 @NotNull
public NetworkListener addListener(@NotNull
                                                                      String id,
                                                                      @NotNull
                                                                      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

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        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

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)

Return the given named metric for this Network Load Balancer.

Default: Average over 5 minutes

Parameters:

metricName - This parameter is required.

metricActiveFlowCount

@Stability(value=Stable)
 @NotNull
public Metric metricActiveFlowCount(@Nullable
                                                                       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

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public Metric metricConsumedLCUs(@Nullable
                                                                    MetricOptions props)

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

Default: Sum over 5 minutes

Parameters:

props -

metricConsumedLCUs

@Stability(value=Stable)
 @NotNull
public Metric metricConsumedLCUs()

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

Default: Sum over 5 minutes

metricNewFlowCount

@Stability(value=Stable)
 @NotNull
public Metric metricNewFlowCount(@Nullable
                                                                    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

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public Metric metricProcessedBytes(@Nullable
                                                                      MetricOptions props)

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

Default: Sum over 5 minutes

Parameters:

props -

metricProcessedBytes

@Stability(value=Stable)
 @NotNull
public Metric metricProcessedBytes()

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

Default: Sum over 5 minutes

metricTcpClientResetCount

@Stability(value=Stable)
 @NotNull
public Metric metricTcpClientResetCount(@Nullable
                                                                           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

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public Metric metricTcpElbResetCount(@Nullable
                                                                        MetricOptions props)

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

Default: Sum over 5 minutes

Parameters:

props -

metricTcpElbResetCount

@Stability(value=Stable)
 @NotNull
public Metric metricTcpElbResetCount()

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

Default: Sum over 5 minutes

metricTcpTargetResetCount

@Stability(value=Stable)
 @NotNull
public Metric metricTcpTargetResetCount(@Nullable
                                                                           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

@Stability(value=Stable)
 @NotNull
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