View a markdown version of this page

HealthCheckConfig - AWS RTB Fabric

HealthCheckConfig

The health check configuration for a managed endpoint. Defines how the service probes instances in the Auto Scaling group to determine their health status.

Contents

path

The destination path for the health check request. Must start with /.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: /.*

Required: Yes

port

The port to use for health check probes. Valid range is 80 to 65535.

Type: Integer

Valid Range: Minimum value of 80. Maximum value of 65535.

Required: Yes

healthyThresholdCount

The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 10.

Required: No

intervalSeconds

The interval between health check probes, in seconds. Valid range is 5 to 60.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 60.

Required: No

protocol

The protocol to use for health check probes.

Type: String

Valid Values: HTTP | HTTPS

Required: No

statusCodeMatcher

The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

timeoutMs

The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

Type: Integer

Valid Range: Minimum value of 100. Maximum value of 5000.

Required: No

unhealthyThresholdCount

The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 10.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: