Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface BaseTargetGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ApplicationTargetGroupProps, NetworkTargetGroupProps

All Known Implementing Classes:

ApplicationTargetGroupProps.Jsii$Proxy, BaseTargetGroupProps.Jsii$Proxy, NetworkTargetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:05.219Z")
@Stability(Stable)
public interface BaseTargetGroupProps
extends software.amazon.jsii.JsiiSerializable

Basic properties of both Application and Network Target Groups.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 Vpc vpc;
 BaseTargetGroupProps baseTargetGroupProps = BaseTargetGroupProps.builder()
         .crossZoneEnabled(false)
         .deregistrationDelay(Duration.minutes(30))
         .healthCheck(HealthCheck.builder()
                 .enabled(false)
                 .healthyGrpcCodes("healthyGrpcCodes")
                 .healthyHttpCodes("healthyHttpCodes")
                 .healthyThresholdCount(123)
                 .interval(Duration.minutes(30))
                 .path("path")
                 .port("port")
                 .protocol(Protocol.HTTP)
                 .timeout(Duration.minutes(30))
                 .unhealthyThresholdCount(123)
                 .build())
         .ipAddressType(TargetGroupIpAddressType.IPV4)
         .targetGroupHealth(TargetGroupHealth.builder()
                 .dnsMinimumHealthyTargetCount(123)
                 .dnsMinimumHealthyTargetPercentage(123)
                 .routingMinimumHealthyTargetCount(123)
                 .routingMinimumHealthyTargetPercentage(123)
                 .build())
         .targetGroupName("targetGroupName")
         .targetType(TargetType.INSTANCE)
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BaseTargetGroupProps.Builder	builder()
default Boolean	getCrossZoneEnabled()	Indicates whether cross zone load balancing is enabled.
default Duration	getDeregistrationDelay()	The amount of time for Elastic Load Balancing to wait before deregistering a target.
default HealthCheck	getHealthCheck()	Health check configuration.
default TargetGroupIpAddressType	getIpAddressType()	The type of IP addresses of the targets registered with the target group.
default TargetGroupHealth	getTargetGroupHealth()	Configuring target group health.
default String	getTargetGroupName()	The name of the target group.
default TargetType	getTargetType()	The type of targets registered to this TargetGroup, either IP or Instance.
default IVpc	getVpc()	The virtual private cloud (VPC).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCrossZoneEnabled

@Stability(Stable)
@Nullable
default Boolean getCrossZoneEnabled()

Indicates whether cross zone load balancing is enabled.

Default: - use load balancer configuration

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html

getDeregistrationDelay

@Stability(Stable)
@Nullable
default Duration getDeregistrationDelay()

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0-3600 seconds.

Default: 300

getHealthCheck

@Stability(Stable)
@Nullable
default HealthCheck getHealthCheck()

Health check configuration.

Default: - The default value for each property in this configuration varies depending on the target.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#aws-resource-elasticloadbalancingv2-targetgroup-properties

getIpAddressType

@Stability(Stable)
@Nullable
default TargetGroupIpAddressType getIpAddressType()

The type of IP addresses of the targets registered with the target group.

Default: undefined - ELB defaults to IPv4

getTargetGroupHealth

@Stability(Stable)
@Nullable
default TargetGroupHealth getTargetGroupHealth()

Configuring target group health.

Default: - use default configuration

See Also:

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

getTargetGroupName

@Stability(Stable)
@Nullable
default String getTargetGroupName()

The name of the target group.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

Default: - Automatically generated.

getTargetType

@Stability(Stable)
@Nullable
default TargetType getTargetType()

The type of targets registered to this TargetGroup, either IP or Instance.

All targets registered into the group must be of this type. If you register targets to the TargetGroup in the CDK app, the TargetType is determined automatically.

Default: - Determined automatically.

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

The virtual private cloud (VPC).

only if TargetType is Ip or InstanceId

Default: - undefined

builder

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

Returns:

a BaseTargetGroupProps.Builder of BaseTargetGroupProps