ServerGroupHealthCheck

data class ServerGroupHealthCheck(val healthCheckConnectPort: Int? = null, val healthCheckConnectTimeout: Int? = null, val healthCheckDomain: String? = null, val healthCheckEnabled: Boolean? = null, val healthCheckHttpCodes: List<String>? = null, val healthCheckInterval: Int? = 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
fun ServerGroupHealthCheck(healthCheckConnectPort: Int? = null, healthCheckConnectTimeout: Int? = null, healthCheckDomain: String? = null, healthCheckEnabled: Boolean? = null, healthCheckHttpCodes: List<String>? = null, healthCheckInterval: Int? = 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 backend port that is used for health checks. Valid values: 0 to 65535. Default value: 0. If you set the value to 0, the port of a backend server is used for health checks.

Link copied to clipboard

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

Link copied to clipboard

The domain name that is used for health checks. Valid values:

Link copied to clipboard

Specifies whether to enable health checks.

Link copied to clipboard

The HTTP status codes to return to health checks. Separate multiple HTTP status codes with commas (,). Valid values: http_2xx (default), http_3xx, http_4xx, and http_5xx. Note: This parameter takes effect only if health_check_type is set to http.

Link copied to clipboard

The interval between two consecutive health checks. Unit: seconds. Valid values: 5 to 5000. Default value: 10.

Link copied to clipboard
val healthCheckType: String? = null

The protocol that is used 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 (/). Note: This parameter takes effect only if health_check_type is set to http.

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 is changed 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 and HEAD. Note: This parameter takes effect only if health_check_type is set to http.

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 is changed from success to fail. Valid values: 2 to 10. Default value: 2.