CfnTargetGroupProps
- class aws_cdk.aws_elasticloadbalancingv2.CfnTargetGroupProps(*, health_check_enabled=None, health_check_interval_seconds=None, health_check_path=None, health_check_port=None, health_check_protocol=None, health_check_timeout_seconds=None, healthy_threshold_count=None, ip_address_type=None, matcher=None, name=None, port=None, protocol=None, protocol_version=None, tags=None, target_group_attributes=None, targets=None, target_type=None, unhealthy_threshold_count=None, vpc_id=None)
Bases:
object
Properties for defining a
CfnTargetGroup
.- Parameters:
health_check_enabled (
Union
[bool
,IResolvable
,None
]) – Indicates whether health checks are enabled. If the target type islambda
, health checks are disabled by default but can be enabled. If the target type isinstance
,ip
, oralb
, health checks are always enabled and cannot be disabled.health_check_interval_seconds (
Union
[int
,float
,None
]) – 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 islambda
, the default is 35 seconds.health_check_path (
Optional
[str
]) – [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.health_check_port (
Optional
[str
]) – 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 istraffic-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.health_check_protocol (
Optional
[str
]) – 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.health_check_timeout_seconds (
Union
[int
,float
,None
]) – 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 islambda
, the default is 30 seconds.healthy_threshold_count (
Union
[int
,float
,None
]) – 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 islambda
, the default is 5.ip_address_type (
Optional
[str
]) – The type of IP address used for this target group. The possible values areipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.matcher (
Union
[IResolvable
,MatcherProperty
,Dict
[str
,Any
],None
]) – [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.name (
Optional
[str
]) – 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.port (
Union
[int
,float
,None
]) – 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.protocol (
Optional
[str
]) – 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.protocol_version (
Optional
[str
]) – [HTTP/HTTPS protocol] The protocol version. The possible values areGRPC
,HTTP1
, andHTTP2
.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags.target_group_attributes (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,TargetGroupAttributeProperty
,Dict
[str
,Any
]]],None
]) – The target group attributes.targets (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,TargetDescriptionProperty
,Dict
[str
,Any
]]],None
]) – The targets.target_type (
Optional
[str
]) – 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.unhealthy_threshold_count (
Union
[int
,float
,None
]) – 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 islambda
, the default is 5.vpc_id (
Optional
[str
]) – 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_elasticloadbalancingv2 as elbv2 cfn_target_group_props = elbv2.CfnTargetGroupProps( health_check_enabled=False, health_check_interval_seconds=123, health_check_path="healthCheckPath", health_check_port="healthCheckPort", health_check_protocol="healthCheckProtocol", health_check_timeout_seconds=123, healthy_threshold_count=123, ip_address_type="ipAddressType", matcher=elbv2.CfnTargetGroup.MatcherProperty( grpc_code="grpcCode", http_code="httpCode" ), name="name", port=123, protocol="protocol", protocol_version="protocolVersion", tags=[CfnTag( key="key", value="value" )], target_group_attributes=[elbv2.CfnTargetGroup.TargetGroupAttributeProperty( key="key", value="value" )], targets=[elbv2.CfnTargetGroup.TargetDescriptionProperty( id="id", # the properties below are optional availability_zone="availabilityZone", port=123 )], target_type="targetType", unhealthy_threshold_count=123, vpc_id="vpcId" )
Attributes
- health_check_enabled
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 isinstance
,ip
, oralb
, health checks are always enabled and cannot be disabled.
- health_check_interval_seconds
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.
- health_check_path
[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.
- health_check_port
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.
- health_check_protocol
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.
- health_check_timeout_seconds
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.
- healthy_threshold_count
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.
- ip_address_type
The type of IP address used for this target group.
The possible values are
ipv4
andipv6
. This is an optional parameter. If not specified, the IP address type defaults toipv4
.
- matcher
[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.
- name
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.
- port
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.
- protocol
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.
- protocol_version
[HTTP/HTTPS protocol] The protocol version.
The possible values are
GRPC
,HTTP1
, andHTTP2
.
- tags
The tags.
- target_group_attributes
The target group attributes.
- target_type
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.
- targets
The targets.
- unhealthy_threshold_count
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.
- vpc_id
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.