Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnTargetGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTargetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:17.040Z")
@Stability(Stable)
public interface CfnTargetGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTargetGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 CfnTargetGroupProps cfnTargetGroupProps = CfnTargetGroupProps.builder()
         .healthCheckEnabled(false)
         .healthCheckIntervalSeconds(123)
         .healthCheckPath("healthCheckPath")
         .healthCheckPort("healthCheckPort")
         .healthCheckProtocol("healthCheckProtocol")
         .healthCheckTimeoutSeconds(123)
         .healthyThresholdCount(123)
         .ipAddressType("ipAddressType")
         .matcher(MatcherProperty.builder()
                 .grpcCode("grpcCode")
                 .httpCode("httpCode")
                 .build())
         .name("name")
         .port(123)
         .protocol("protocol")
         .protocolVersion("protocolVersion")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetGroupAttributes(List.of(TargetGroupAttributeProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targets(List.of(TargetDescriptionProperty.builder()
                 .id("id")
                 // the properties below are optional
                 .availabilityZone("availabilityZone")
                 .port(123)
                 .build()))
         .targetType("targetType")
         .unhealthyThresholdCount(123)
         .vpcId("vpcId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTargetGroupProps.Builder	builder()
default Object	getHealthCheckEnabled()	Indicates whether health checks are enabled.
default Number	getHealthCheckIntervalSeconds()	The approximate amount of time, in seconds, between health checks of an individual target.
default String	getHealthCheckPath()	[HTTP/HTTPS health checks] The destination for health checks on the targets.
default String	getHealthCheckPort()	The port the load balancer uses when performing health checks on targets.
default String	getHealthCheckProtocol()	The protocol the load balancer uses when performing health checks on targets.
default Number	getHealthCheckTimeoutSeconds()	The amount of time, in seconds, during which no response from a target means a failed health check.
default Number	getHealthyThresholdCount()	The number of consecutive health check successes required before considering a target healthy.
default String	getIpAddressType()	The type of IP address used for this target group.
default Object	getMatcher()	[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
default String	getName()	The name of the target group.
default Number	getPort()	The port on which the targets receive traffic.
default String	getProtocol()	The protocol to use for routing traffic to the targets.
default String	getProtocolVersion()	[HTTP/HTTPS protocol] The protocol version.
default List<CfnTag>	getTags()	The tags.
default Object	getTargetGroupAttributes()	The attributes.
default Object	getTargets()	The targets.
default String	getTargetType()	The type of target that you must specify when registering targets with this target group.
default Number	getUnhealthyThresholdCount()	The number of consecutive health check failures required before considering a target unhealthy.
default String	getVpcId()	The identifier of the virtual private cloud (VPC).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHealthCheckEnabled

@Stability(Stable)
@Nullable
default Object getHealthCheckEnabled()

Indicates whether health checks are enabled.

If the target type is lambda , health checks are disabled by default but can be enabled. If the target type is instance , ip , or alb , health checks are always enabled and cannot be disabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled

getHealthCheckIntervalSeconds

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

The approximate amount of time, in seconds, between health checks of an individual target.

The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda , the default is 35 seconds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds

getHealthCheckPath

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

[HTTP/HTTPS health checks] The destination for health checks on the targets.

[HTTP1 or HTTP2 protocol version] The ping path. The default is /.

[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is / AWS .ALB/healthcheck.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath

getHealthCheckPort

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

The port the load balancer uses when performing health checks on targets.

If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port , which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport

getHealthCheckProtocol

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

The protocol the load balancer uses when performing health checks on targets.

For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol

getHealthCheckTimeoutSeconds

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

The amount of time, in seconds, during which no response from a target means a failed health check.

The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda , the default is 30 seconds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds

getHealthyThresholdCount

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

The number of consecutive health check successes required before considering a target healthy.

The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is lambda , the default is 5.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount

getIpAddressType

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

The type of IP address used for this target group.

The possible values are ipv4 and ipv6 . This is an optional parameter. If not specified, the IP address type defaults to ipv4 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-ipaddresstype

getMatcher

@Stability(Stable)
@Nullable
default Object getMatcher()

[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.

For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher

getName

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name

getPort

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

The port on which the targets receive traffic.

This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port

getProtocol

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

The protocol to use for routing traffic to the targets.

For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol

getProtocolVersion

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

[HTTP/HTTPS protocol] The protocol version.

The possible values are GRPC , HTTP1 , and HTTP2 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocolversion

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags

getTargetGroupAttributes

@Stability(Stable)
@Nullable
default Object getTargetGroupAttributes()

The attributes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes

getTargets

@Stability(Stable)
@Nullable
default Object getTargets()

The targets.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets

getTargetType

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

The type of target that you must specify when registering targets with this target group.

You can't specify targets for a target group using more than one target type.

• instance - Register targets by instance ID. This is the default value.
• ip - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
• lambda - Register a single Lambda function as a target.
• alb - Register a single Application Load Balancer as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype

getUnhealthyThresholdCount

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

The number of consecutive health check failures required before considering a target unhealthy.

The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is lambda , the default is 5.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount

getVpcId

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

The identifier of the virtual private cloud (VPC).

If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid

builder

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

Returns:

a CfnTargetGroupProps.Builder of CfnTargetGroupProps