Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface NetworkTargetGroupProps

All Superinterfaces:

BaseTargetGroupProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NetworkTargetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:42:51.740Z")
@Stability(Stable)
public interface NetworkTargetGroupProps
extends software.amazon.jsii.JsiiSerializable, BaseTargetGroupProps

Properties for a new Network Target Group.

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.*;
 INetworkLoadBalancerTarget networkLoadBalancerTarget;
 Vpc vpc;
 NetworkTargetGroupProps networkTargetGroupProps = NetworkTargetGroupProps.builder()
         .port(123)
         // the properties below are optional
         .connectionTermination(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())
         .preserveClientIp(false)
         .protocol(Protocol.HTTP)
         .proxyProtocolV2(false)
         .targetGroupName("targetGroupName")
         .targets(List.of(networkLoadBalancerTarget))
         .targetType(TargetType.INSTANCE)
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NetworkTargetGroupProps.Builder	builder()
default Boolean	getConnectionTermination()	Indicates whether the load balancer terminates connections at the end of the deregistration timeout.
Number	getPort()	The port on which the target receives traffic.
default Boolean	getPreserveClientIp()	Indicates whether client IP preservation is enabled.
default Protocol	getProtocol()	Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.
default Boolean	getProxyProtocolV2()	Indicates whether Proxy Protocol version 2 is enabled.
default List<INetworkLoadBalancerTarget>	getTargets()	The targets to add to this target group.

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

getDeregistrationDelay, getHealthCheck, getTargetGroupName, getTargetType, getVpc

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPort

@Stability(Stable)
@NotNull
Number getPort()

The port on which the target receives traffic.

getConnectionTermination

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

Indicates whether the load balancer terminates connections at the end of the deregistration timeout.

Default: false

getPreserveClientIp

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

Indicates whether client IP preservation is enabled.

Default: false if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, true.

getProtocol

@Stability(Stable)
@Nullable
default Protocol getProtocol()

Protocol for target group, expects TCP, TLS, UDP, or TCP_UDP.

Default: - TCP

getProxyProtocolV2

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

Indicates whether Proxy Protocol version 2 is enabled.

Default: false

getTargets

@Stability(Stable)
@Nullable
default List<INetworkLoadBalancerTarget> getTargets()

The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing target. If you use either Instance or IPAddress as targets, all target must be of the same type.

Default: - No targets.

builder

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

Returns:

a NetworkTargetGroupProps.Builder of NetworkTargetGroupProps