HttpHealthCheckArgs

data class HttpHealthCheckArgs(val checkIntervalSec: Output<Int>? = null, val description: Output<String>? = null, val healthyThreshold: Output<Int>? = null, val host: Output<String>? = null, val name: Output<String>? = null, val port: Output<Int>? = null, val project: Output<String>? = null, val requestId: Output<String>? = null, val requestPath: Output<String>? = null, val timeoutSec: Output<Int>? = null, val unhealthyThreshold: Output<Int>? = null) : ConvertibleToJava<HttpHealthCheckArgs>

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Constructors

Link copied to clipboard
fun HttpHealthCheckArgs(checkIntervalSec: Output<Int>? = null, description: Output<String>? = null, healthyThreshold: Output<Int>? = null, host: Output<String>? = null, name: Output<String>? = null, port: Output<Int>? = null, project: Output<String>? = null, requestId: Output<String>? = null, requestPath: Output<String>? = null, timeoutSec: Output<Int>? = null, unhealthyThreshold: Output<Int>? = null)

Functions

Link copied to clipboard
open override fun toJava(): HttpHealthCheckArgs

Properties

Link copied to clipboard
val checkIntervalSec: Output<Int>? = null

How often (in seconds) to send a health check. The default value is 5 seconds.

Link copied to clipboard
val description: Output<String>? = null

An optional description of this resource. Provide this property when you create the resource.

Link copied to clipboard
val healthyThreshold: Output<Int>? = null

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Link copied to clipboard
val host: Output<String>? = null

The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

Link copied to clipboard
val name: Output<String>? = null

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Link copied to clipboard
val port: Output<Int>? = null

The TCP port number for the HTTP health check request. The default value is 80.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val requestId: Output<String>? = null

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Link copied to clipboard
val requestPath: Output<String>? = null

The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.

Link copied to clipboard
val timeoutSec: Output<Int>? = null

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

Link copied to clipboard
val unhealthyThreshold: Output<Int>? = null

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.