CfnTargetGroupProps Struct
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 { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';
const cfnTargetGroupProps: elbv2.CfnTargetGroupProps = {
healthCheckEnabled: false,
healthCheckIntervalSeconds: 123,
healthCheckPath: 'healthCheckPath',
healthCheckPort: 'healthCheckPort',
healthCheckProtocol: 'healthCheckProtocol',
healthCheckTimeoutSeconds: 123,
healthyThresholdCount: 123,
ipAddressType: 'ipAddressType',
matcher: {
grpcCode: 'grpcCode',
httpCode: 'httpCode',
},
name: 'name',
port: 123,
protocol: 'protocol',
protocolVersion: 'protocolVersion',
tags: [{
key: 'key',
value: 'value',
}],
targetControlPort: 123,
targetGroupAttributes: [{
key: 'key',
value: 'value',
}],
targets: [{
id: 'id',
// the properties below are optional
availabilityZone: 'availabilityZone',
port: 123,
quicServerId: 'quicServerId',
}],
targetType: 'targetType',
unhealthyThresholdCount: 123,
vpcId: 'vpcId',
};
Properties
healthCheckEnabledoptionalboolean | IResolvablehealth_check_enabledoptionaltyping.Union[bool, IResolvable]healthCheckEnabledoptionalBooleanHealthCheckEnabledoptionalboolHealthCheckEnabledoptionalinterface{}#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 can't be disabled.
healthCheckIntervalSecondsoptionalnumberhealth_check_interval_secondsoptionalint | floathealthCheckIntervalSecondsoptionalNumberHealthCheckIntervalSecondsoptionaldoubleHealthCheckIntervalSecondsoptional*float64#notes
The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, QUIC, TCP_QUIC, 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.
healthCheckPathoptionalstringhealth_check_pathoptionalstrhealthCheckPathoptionalStringHealthCheckPathoptionalstringHealthCheckPathoptional*string#[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.
healthCheckPortoptionalstringhealth_check_portoptionalstrhealthCheckPortoptionalStringHealthCheckPortoptionalstringHealthCheckPortoptional*string#If the protocol is HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC 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.
healthCheckProtocoloptionalstringhealth_check_protocoloptionalstrhealthCheckProtocoloptionalStringHealthCheckProtocoloptionalstringHealthCheckProtocoloptional*string#notes
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, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.
healthCheckTimeoutSecondsoptionalnumberhealth_check_timeout_secondsoptionalint | floathealthCheckTimeoutSecondsoptionalNumberHealthCheckTimeoutSecondsoptionaldoubleHealthCheckTimeoutSecondsoptional*float64#notes
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.
healthyThresholdCountoptionalnumberhealthy_threshold_countoptionalint | floathealthyThresholdCountoptionalNumberHealthyThresholdCountoptionaldoubleHealthyThresholdCountoptional*float64#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.
ipAddressTypeoptionalstringip_address_typeoptionalstripAddressTypeoptionalStringIpAddressTypeoptionalstringIpAddressTypeoptional*string#The default value is ipv4 .
matcheroptionalIResolvable | CfnTargetGroup.MatcherPropertymatcheroptionaltyping.Union[IResolvable, MatcherProperty]matcheroptionalIResolvableMatcheroptionalIResolvableMatcheroptionalinterface{}#notes
For target groups with a protocol of TCP, TCP_UDP, UDP, QUIC, TCP_QUIC, 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.
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.
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.
protocoloptionalstringprotocoloptionalstrprotocoloptionalStringProtocoloptionalstringProtocoloptional*string#notes
For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. A TCP_QUIC listener must be associated with a TCP_QUIC target group. If the target is a Lambda function, this parameter does not apply.
protocolVersionoptionalstringprotocol_versionoptionalstrprotocolVersionoptionalStringProtocolVersionoptionalstringProtocolVersionoptional*string#The possible values are GRPC , HTTP1 , and HTTP2 .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#targetControlPortoptionalnumbertarget_control_portoptionalint | floattargetControlPortoptionalNumberTargetControlPortoptionaldoubleTargetControlPortoptional*float64#targetGroupAttributesoptionalIResolvable | IResolvable | CfnTargetGroup.TargetGroupAttributeProperty[]target_group_attributesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetGroupAttributeProperty]]]targetGroupAttributesoptionalIResolvableTargetGroupAttributesoptionalIResolvableTargetGroupAttributesoptionalinterface{}#Attributes that you do not modify retain their current values.
targetsoptionalIResolvable | IResolvable | CfnTargetGroup.TargetDescriptionProperty[]targetsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetDescriptionProperty]]]targetsoptionalIResolvableTargetsoptionalIResolvableTargetsoptionalinterface{}#targetTypeoptionalstringtarget_typeoptionalstrtargetTypeoptionalStringTargetTypeoptionalstringTargetTypeoptional*string#notes
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.
unhealthyThresholdCountoptionalnumberunhealthy_threshold_countoptionalint | floatunhealthyThresholdCountoptionalNumberUnhealthyThresholdCountoptionaldoubleUnhealthyThresholdCountoptional*float64#The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, QUIC, TCP_QUIC, 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.