ServerGroupHealthCheckConfig

data class ServerGroupHealthCheckConfig(val healthCheckCodes: List<String>? = null, val healthCheckConnectPort: Int? = null, val healthCheckEnabled: Boolean, val healthCheckHost: String? = null, val healthCheckHttpVersion: String? = null, val healthCheckInterval: Int? = null, val healthCheckMethod: String? = null, val healthCheckPath: String? = null, val healthCheckProtocol: String? = null, val healthCheckTimeout: Int? = null, val healthyThreshold: Int? = null, val unhealthyThreshold: Int? = null)

Constructors

Link copied to clipboard
constructor(healthCheckCodes: List<String>? = null, healthCheckConnectPort: Int? = null, healthCheckEnabled: Boolean, healthCheckHost: String? = null, healthCheckHttpVersion: String? = null, healthCheckInterval: Int? = null, healthCheckMethod: String? = null, healthCheckPath: String? = null, healthCheckProtocol: String? = null, healthCheckTimeout: Int? = null, healthyThreshold: Int? = null, unhealthyThreshold: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The HTTP status codes that are used to indicate whether the backend server passes the health check. Valid values:

Link copied to clipboard

The backend port that is used for health checks. Default value: 0. Valid values: 0 to 65535. A value of 0 indicates that a backend server port is used for health checks.

Link copied to clipboard

Specifies whether to enable the health check feature. Valid values: true, false.

Link copied to clipboard
val healthCheckHost: String? = null

The domain name that is used for health checks.

Link copied to clipboard

The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0 and HTTP1.1. NOTE: This parameter takes effect only when health_check_protocol is set to HTTP or HTTPS.

Link copied to clipboard

The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.

Link copied to clipboard

The HTTP method that is used for health checks. Default value: GET. Valid values: GET, POST, HEAD. NOTE: This parameter takes effect only when health_check_protocol is set to HTTP, HTTPS, or gRPC. From version 1.215.0, health_check_method can be set to POST.

Link copied to clipboard
val healthCheckPath: String? = null

The path that is used for health checks. NOTE: This parameter takes effect only when health_check_protocol is set to HTTP or HTTPS.

Link copied to clipboard

The protocol that is used for health checks. Valid values: HTTP, HTTPS, TCP and gRPC.

Link copied to clipboard
val healthCheckTimeout: Int? = null

The timeout period for a health check response. If a backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the ECS instance is considered unhealthy. Unit: seconds. Default value: 5. Valid values: 1 to 300. NOTE: If the value of health_check_timeout is smaller than the value of health_check_interval, the value of health_check_timeout is ignored and the value of health_check_interval is used.

Link copied to clipboard
val healthyThreshold: Int? = null

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.

Link copied to clipboard
val unhealthyThreshold: Int? = null

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.