software.amazon.awscdk.services.elasticloadbalancingv2

Class NetworkTargetGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.elasticloadbalancingv2.TargetGroupBase

software.amazon.awscdk.services.elasticloadbalancingv2.NetworkTargetGroup

All Implemented Interfaces:

IConstruct, IDependable, INetworkTargetGroup, ITargetGroup

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.687Z")
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 interface software.amazon.awscdk.services.elasticloadbalancingv2.INetworkTargetGroup

INetworkTargetGroup.Jsii$Default, INetworkTargetGroup.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addTarget(INetworkLoadBalancerTarget... targets) Add a load balancing target to this target group.
static INetworkTargetGroup	doImport(software.constructs.Construct scope, java.lang.String id, TargetGroupImportProps props) Deprecated. Use `fromTargetGroupAttributes` instead
static INetworkTargetGroup	fromTargetGroupAttributes(software.constructs.Construct scope, java.lang.String id, TargetGroupAttributes attrs) Import an existing target group.
java.lang.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 java.util.List<java.lang.String>	validate() Validate the current construct.

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

getLoadBalancerArns, getLoadBalancerAttached, getTargetGroupArn, getTargetGroupName

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

getNode

Constructor Detail

NetworkTargetGroup

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

NetworkTargetGroup

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

NetworkTargetGroup

public NetworkTargetGroup(software.constructs.Construct scope,
                          java.lang.String id,
                          NetworkTargetGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromTargetGroupAttributes

public static INetworkTargetGroup fromTargetGroupAttributes(software.constructs.Construct scope,
                                                            java.lang.String id,
                                                            TargetGroupAttributes attrs)

Import an existing target group.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

doImport

@Deprecated
public static INetworkTargetGroup doImport(software.constructs.Construct scope,
                                                       java.lang.String id,
                                                       TargetGroupImportProps props)

Deprecated. Use `fromTargetGroupAttributes` instead

(deprecated) Import an existing listener.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

addTarget

public void addTarget(INetworkLoadBalancerTarget... targets)

Add a load balancing target to this target group.

Specified by:

addTarget in interface INetworkTargetGroup

Parameters:

targets - This parameter is required.

metricHealthyHostCount

public Metric metricHealthyHostCount(MetricOptions props)

The number of targets that are considered healthy.

Default: Average over 5 minutes

Parameters:

props -

metricHealthyHostCount

public Metric metricHealthyHostCount()

The number of targets that are considered healthy.

Default: Average over 5 minutes

metricUnHealthyHostCount

public Metric metricUnHealthyHostCount(MetricOptions props)

The number of targets that are considered unhealthy.

Default: Average over 5 minutes

Parameters:

props -

metricUnHealthyHostCount

public Metric metricUnHealthyHostCount()

The number of targets that are considered unhealthy.

Default: Average over 5 minutes

registerListener

public void registerListener(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.

validate

protected java.util.List<java.lang.String> validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class TargetGroupBase

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getFirstLoadBalancerFullName

public java.lang.String getFirstLoadBalancerFullName()

Full name of first load balancer.

Specified by:

getFirstLoadBalancerFullName in class TargetGroupBase