HealthCheckConfig

Describes the health check configuration of a target group. Health check configurations aren't used for target groups of type LAMBDA or ALB.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Indicates whether health checking is enabled.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The codes to use when checking for a successful response from a target.

Link copied to clipboard
val 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.

Link copied to clipboard
val port: Int?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: HealthCheckConfig.Builder.() -> Unit = {}): HealthCheckConfig
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String