vpclattice/aws.sdk.kotlin.services.vpclattice.model/HealthCheckConfig/Builder

Builder

Properties

Indicates whether health checking is enabled.

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

healthCheckTimeoutSeconds

var healthCheckTimeoutSeconds: Int?

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

healthyThresholdCount

var healthyThresholdCount: Int?

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

matcher

var matcher: Matcher?

The codes to use when checking for a successful response from a target. These are called Success codes in the console.

path

var path: String?

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

port

var port: Int?

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

protocol

var protocol: TargetGroupProtocol?

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

protocolVersion

var protocolVersion: HealthCheckProtocolVersion?

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

unhealthyThresholdCount

var unhealthyThresholdCount: Int?

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.