ServerGroupHealthCheck

data class ServerGroupHealthCheck(val healthCheckConnectPort: Int? = null, val healthCheckConnectTimeout: Int? = null, val healthCheckDomain: String? = null, val healthCheckEnabled: Boolean? = null, val healthCheckExp: String? = null, val healthCheckHttpCodes: List<String>? = null, val healthCheckInterval: Int? = null, val healthCheckReq: String? = null, val healthCheckType: String? = null, val healthCheckUrl: String? = null, val healthyThreshold: Int? = null, val httpCheckMethod: String? = null, val unhealthyThreshold: Int? = null)

Constructors

Link copied to clipboard
constructor(healthCheckConnectPort: Int? = null, healthCheckConnectTimeout: Int? = null, healthCheckDomain: String? = null, healthCheckEnabled: Boolean? = null, healthCheckExp: String? = null, healthCheckHttpCodes: List<String>? = null, healthCheckInterval: Int? = null, healthCheckReq: String? = null, healthCheckType: String? = null, healthCheckUrl: String? = null, healthyThreshold: Int? = null, httpCheckMethod: String? = null, unhealthyThreshold: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The port that you want to use for health checks on backend servers. Valid values: 0 to 65535. Default value: 0. If you set the value to 0, the port of the backend server is used for health checks.

Link copied to clipboard

The maximum timeout period of a health check. Unit: seconds. Valid values: 1 to 300. Default value: 5.

Link copied to clipboard

The domain name that you want to use for health checks. Valid values:

Link copied to clipboard

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

Link copied to clipboard
val healthCheckExp: String? = null

health check response character string. The value contains a maximum of 512 characters

Link copied to clipboard

The HTTP status codes to return for health checks. Separate multiple HTTP status codes with commas (,). Valid values: http\_2xx (default), http\_3xx, http\_4xx, and http\_5xx.

Link copied to clipboard

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

Link copied to clipboard
val healthCheckReq: String? = null

UDP healthy check request string, the value is a character string of 512 characters

Link copied to clipboard
val healthCheckType: String? = null

The protocol that you want to use for health checks. Valid values: TCP (default) and HTTP.

Link copied to clipboard
val healthCheckUrl: String? = null

The path to which health check requests are sent. The path must be 1 to 80 characters in length, and can contain only letters, digits, and the following special characters: - / . % ? # & =. It can also contain the following extended characters: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , +. The path must start with a forward slash (/).

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. In this case, the health status changes from fail to success. Valid values: 2 to 10. Default value: 2.

Link copied to clipboard
val httpCheckMethod: String? = null

The HTTP method that is used for health checks. Valid values: GET (default) and HEAD.

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. In this case, the health status changes from success to fail. Valid values: 2 to 10. Default value: 2.