software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkTargetGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkTargetGroup

All Implemented Interfaces:

INetworkTargetGroup, ITargetGroup, 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.129Z")
 @Stability(value=Stable)
public class NetworkTargetGroup
extends TargetGroupBase
implements INetworkTargetGroup

Define a Network Target Group.

Example:

 NetworkListener listener;
 AutoScalingGroup asg1;
 AutoScalingGroup asg2;
 NetworkTargetGroup group = listener.addTargets("AppFleet", AddNetworkTargetsProps.builder()
         .port(443)
         .targets(List.of(asg1))
         .build());
 group.addTarget(asg2);
 

Nested Class Summary

Nested Classes

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

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.INetworkTargetGroup

INetworkTargetGroup.Jsii$Default, INetworkTargetGroup.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addTarget(INetworkLoadBalancerTarget... targets) Add a load balancing target to this target group.
static INetworkTargetGroup	fromTargetGroupAttributes(software.constructs.Construct scope, String id, TargetGroupAttributes attrs) Import an existing target group.
String	getFirstLoadBalancerFullName() Full name of first load balancer.
Metric	metricHealthyHostCount() The number of targets that are considered healthy.
Metric	metricHealthyHostCount(MetricOptions props) The number of targets that are considered healthy.
Metric	metricUnHealthyHostCount() The number of targets that are considered unhealthy.
Metric	metricUnHealthyHostCount(MetricOptions props) The number of targets that are considered unhealthy.
void	registerListener(INetworkListener listener) Register a listener that is load balancing to this target group.
protected List<String>	validateTargetGroup()

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

addLoadBalancerTarget, configureHealthCheck, getDefaultPort, getHealthCheck, getLoadBalancerArns, getLoadBalancerAttached, getLoadBalancerAttachedDependencies, getTargetGroupArn, getTargetGroupFullName, getTargetGroupLoadBalancerArns, getTargetGroupName, getTargetType, setAttribute, setAttribute, setHealthCheck, setTargetType

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.ITargetGroup

getLoadBalancerArns, getLoadBalancerAttached, getTargetGroupArn, getTargetGroupName

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

NetworkTargetGroup

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

NetworkTargetGroup

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

NetworkTargetGroup

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromTargetGroupAttributes

@Stability(value=Stable)
 @NotNull
public static INetworkTargetGroup fromTargetGroupAttributes(@NotNull
                                                                                               software.constructs.Construct scope,
                                                                                               @NotNull
                                                                                               String id,
                                                                                               @NotNull
                                                                                               TargetGroupAttributes attrs)

Import an existing target group.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addTarget

@Stability(value=Stable)
public void addTarget(@NotNull
                                               INetworkLoadBalancerTarget... targets)

Add a load balancing target to this target group.

Specified by:

addTarget in interface INetworkTargetGroup

Parameters:

targets - This parameter is required.

metricHealthyHostCount

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

The number of targets that are considered healthy.

Default: Average over 5 minutes

Parameters:

props -

metricHealthyHostCount

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

The number of targets that are considered healthy.

Default: Average over 5 minutes

metricUnHealthyHostCount

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

The number of targets that are considered unhealthy.

Default: Average over 5 minutes

Parameters:

props -

metricUnHealthyHostCount

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

The number of targets that are considered unhealthy.

Default: Average over 5 minutes

registerListener

@Stability(value=Stable)
public void registerListener(@NotNull
                                                      INetworkListener listener)

Register a listener that is load balancing to this target group.

Don't call this directly. It will be called by listeners.

Specified by:

registerListener in interface INetworkTargetGroup

Parameters:

listener - This parameter is required.

validateTargetGroup

@Stability(value=Stable)
 @NotNull
protected List<String> validateTargetGroup()

Overrides:

validateTargetGroup in class TargetGroupBase

getFirstLoadBalancerFullName

@Stability(value=Stable)
 @NotNull
public String getFirstLoadBalancerFullName()

Full name of first load balancer.

Specified by:

getFirstLoadBalancerFullName in class TargetGroupBase