Modifies the health checks used when evaluating the health state of the targets in the specified target group.
To monitor the health of the targets, use DescribeTargetHealth.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- HealthCheckEnabled
-
Indicates whether health checks are enabled.
Type: Boolean
Required: No
- HealthCheckIntervalSeconds
-
The approximate amount of time, in seconds, between health checks of an individual target.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 300.
Required: No
- HealthCheckPath
-
[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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- HealthCheckPort
-
The port the load balancer uses when performing health checks on targets.
Type: String
Required: No
- HealthCheckProtocol
-
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, and TCP_UDP protocols are not supported for health checks.
Type: String
Valid Values:
HTTP | HTTPS | TCP | TLS | UDP | TCP_UDP | GENEVERequired: No
- HealthCheckTimeoutSeconds
-
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 120.
Required: No
- HealthyThresholdCount
-
The number of consecutive health checks successes required before considering an unhealthy target healthy.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No
- 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.
Type: Matcher object
Required: No
- TargetGroupArn
-
The Amazon Resource Name (ARN) of the target group.
Type: String
Required: Yes
- UnhealthyThresholdCount
-
The number of consecutive health check failures required before considering the target unhealthy.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No
Response Elements
The following element is returned by the service.
- TargetGroups.member.N
-
Information about the modified target group.
Type: Array of TargetGroup objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidConfigurationRequest
-
The requested configuration is not valid.
HTTP Status Code: 400
- TargetGroupNotFound
-
The specified target group does not exist.
HTTP Status Code: 400
Examples
Modify the health check configuration for a target group
This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.
Sample Request
https://elasticloadbalancing.amazonaws.com/?Action=ModifyTargetGroup
&TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f
&HealthCheckProtocol=HTTPS
&HealthCheckPort=443
&Version=2015-12-01
&AUTHPARAMSSample Response
<ModifyTargetGroupResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/">
<ModifyTargetGroupResult>
<TargetGroups>
<member>
<TargetGroupArn>arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f</TargetGroupArn>
<HealthCheckTimeoutSeconds>5</HealthCheckTimeoutSeconds>
<HealthCheckPort>443</HealthCheckPort>
<Matcher>
<HttpCode>200</HttpCode>
</Matcher>
<TargetGroupName>my-https-targets</TargetGroupName>
<HealthCheckProtocol>HTTPS</HealthCheckProtocol>
<Protocol>HTTPS</Protocol>
<Port>443</Port>
<HealthyThresholdCount>5</HealthyThresholdCount>
<VpcId>vpc-3ac0fb5f</VpcId>
<HealthCheckIntervalSeconds>30</HealthCheckIntervalSeconds>
<LoadBalancerArns>
<member>arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188</member>
</LoadBalancerArns>
<UnhealthyThresholdCount>2</UnhealthyThresholdCount>
</member>
</TargetGroups>
</ModifyTargetGroupResult>
<ResponseMetadata>
<RequestId>8525b334-f466-11e5-aa04-33bf366f62e2</RequestId>
</ResponseMetadata>
</ModifyTargetGroupResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
