v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14102416378.4 KB

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

get/#Action=ModifyTargetGroup

Query parameters

TargetGroupArnstring required

The Amazon Resource Name (ARN) of the target group.

HealthCheckProtocol'HTTP' | 'HTTPS' | 'TCP' | 'TLS' | 'UDP' | 'TCP_UDP' | 'GENEVE' | 'QUIC' | 'TCP_QUIC'

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. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.

HealthCheckPortstring

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

HealthCheckPathstring
<p>[HTTP/HTTPS health checks] The destination for health checks on the targets.</p> <p>[HTTP1 or HTTP2 protocol version] The ping path. The default is /.</p> <p>[GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.</p>
HealthCheckEnabledboolean

Indicates whether health checks are enabled. If the target type is <code>lambda</code>, health checks are disabled by default but can be enabled. If the target type is <code>instance</code>, <code>ip</code>, or <code>alb</code>, health checks are always enabled and can't be disabled.

HealthCheckIntervalSecondsinteger

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

HealthCheckTimeoutSecondsinteger

[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.

HealthyThresholdCountinteger

The number of consecutive health checks successes required before considering an unhealthy target healthy.

UnhealthyThresholdCountinteger

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

HttpCodestring
<p>For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").</p> <p>For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").</p> <p>For Gateway Load Balancers, this must be "200–399".</p> <p>Note that when using shorthand syntax, some values such as commas need to be escaped.</p>
GrpcCodestring

You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.

[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.

Action'ModifyTargetGroup' required
Version'2015-12-01' required

Response

Success