Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface TargetGroupHealth

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TargetGroupHealth.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-22T11:33:06.461Z")
@Stability(Stable)
public interface TargetGroupHealth
extends software.amazon.jsii.JsiiSerializable

Properties for configuring a target group health.

Example:

 Vpc vpc;
 ApplicationTargetGroup targetGroup = ApplicationTargetGroup.Builder.create(this, "TargetGroup")
         .vpc(vpc)
         .port(80)
         .targetGroupHealth(TargetGroupHealth.builder()
                 .dnsMinimumHealthyTargetCount(3)
                 .dnsMinimumHealthyTargetPercentage(70)
                 .routingMinimumHealthyTargetCount(2)
                 .routingMinimumHealthyTargetPercentage(50)
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TargetGroupHealth.Builder	A builder for TargetGroupHealth
static final class	TargetGroupHealth.Jsii$Proxy	An implementation for TargetGroupHealth

Method Summary

Modifier and Type	Method	Description
static TargetGroupHealth.Builder	builder()
default Number	getDnsMinimumHealthyTargetCount()	The minimum number of targets that must be healthy for DNS failover.
default Number	getDnsMinimumHealthyTargetPercentage()	The minimum percentage of targets that must be healthy for DNS failover.
default Number	getRoutingMinimumHealthyTargetCount()	The minimum number of targets that must be healthy for unhealthy state routing.
default Number	getRoutingMinimumHealthyTargetPercentage()	The minimum percentage of targets that must be healthy for unhealthy state routing.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDnsMinimumHealthyTargetCount

@Stability(Stable)
@Nullable
default Number getDnsMinimumHealthyTargetCount()

The minimum number of targets that must be healthy for DNS failover.

If below this value, mark the zone as unhealthy in DNS. Use 0 for "off".

Default: 1

getDnsMinimumHealthyTargetPercentage

@Stability(Stable)
@Nullable
default Number getDnsMinimumHealthyTargetPercentage()

The minimum percentage of targets that must be healthy for DNS failover.

If below this value, mark the zone as unhealthy in DNS. Use 0 for "off".

Default: 0

getRoutingMinimumHealthyTargetCount

@Stability(Stable)
@Nullable
default Number getRoutingMinimumHealthyTargetCount()

The minimum number of targets that must be healthy for unhealthy state routing.

If below this value, send traffic to all targets including unhealthy ones.

Default: 1

getRoutingMinimumHealthyTargetPercentage

@Stability(Stable)
@Nullable
default Number getRoutingMinimumHealthyTargetPercentage()

The minimum percentage of targets that must be healthy for unhealthy state routing.

If below this value, send traffic to all targets including unhealthy ones. Use 0 for "off".

Default: 0

builder

@Stability(Stable)
static TargetGroupHealth.Builder builder()

Returns:

a TargetGroupHealth.Builder of TargetGroupHealth