HealthCheckArgs

data class HealthCheckArgs(val checkIntervalSec: Output<Int>? = null, val description: Output<String>? = null, val grpcHealthCheck: Output<GRPCHealthCheckArgs>? = null, val healthyThreshold: Output<Int>? = null, val http2HealthCheck: Output<HTTP2HealthCheckArgs>? = null, val httpHealthCheck: Output<HTTPHealthCheckArgs>? = null, val httpsHealthCheck: Output<HTTPSHealthCheckArgs>? = null, val kind: Output<String>? = null, val logConfig: Output<HealthCheckLogConfigArgs>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val requestId: Output<String>? = null, val sourceRegions: Output<List<String>>? = null, val sslHealthCheck: Output<SSLHealthCheckArgs>? = null, val tcpHealthCheck: Output<TCPHealthCheckArgs>? = null, val timeoutSec: Output<Int>? = null, val type: Output<HealthCheckType>? = null, val udpHealthCheck: Output<UDPHealthCheckArgs>? = null, val unhealthyThreshold: Output<Int>? = null) : ConvertibleToJava<HealthCheckArgs>

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

Constructors

Link copied to clipboard
fun HealthCheckArgs(checkIntervalSec: Output<Int>? = null, description: Output<String>? = null, grpcHealthCheck: Output<GRPCHealthCheckArgs>? = null, healthyThreshold: Output<Int>? = null, http2HealthCheck: Output<HTTP2HealthCheckArgs>? = null, httpHealthCheck: Output<HTTPHealthCheckArgs>? = null, httpsHealthCheck: Output<HTTPSHealthCheckArgs>? = null, kind: Output<String>? = null, logConfig: Output<HealthCheckLogConfigArgs>? = null, name: Output<String>? = null, project: Output<String>? = null, requestId: Output<String>? = null, sourceRegions: Output<List<String>>? = null, sslHealthCheck: Output<SSLHealthCheckArgs>? = null, tcpHealthCheck: Output<TCPHealthCheckArgs>? = null, timeoutSec: Output<Int>? = null, type: Output<HealthCheckType>? = null, udpHealthCheck: Output<UDPHealthCheckArgs>? = null, unhealthyThreshold: Output<Int>? = null)

Functions

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

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
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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val kind: Output<String>? = null

Type of the resource.

Link copied to clipboard
val logConfig: Output<HealthCheckLogConfigArgs>? = null

Configure logging on this health check.

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. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.

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 sourceRegions: Output<List<String>>? = null

The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of GCP regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.

Link copied to clipboard
val sslHealthCheck: Output<SSLHealthCheckArgs>? = null
Link copied to clipboard
val tcpHealthCheck: Output<TCPHealthCheckArgs>? = null
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 type: Output<HealthCheckType>? = null

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.

Link copied to clipboard
val udpHealthCheck: Output<UDPHealthCheckArgs>? = null
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.