HTTPHealthCheckArgs

data class HTTPHealthCheckArgs(val host: Output<String>? = null, val port: Output<Int>? = null, val portName: Output<String>? = null, val portSpecification: Output<HTTPHealthCheckPortSpecification>? = null, val proxyHeader: Output<HTTPHealthCheckProxyHeader>? = null, val requestPath: Output<String>? = null, val response: Output<String>? = null) : ConvertibleToJava<HTTPHealthCheckArgs>

Constructors

Link copied to clipboard
fun HTTPHealthCheckArgs(host: Output<String>? = null, port: Output<Int>? = null, portName: Output<String>? = null, portSpecification: Output<HTTPHealthCheckPortSpecification>? = null, proxyHeader: Output<HTTPHealthCheckProxyHeader>? = null, requestPath: Output<String>? = null, response: Output<String>? = null)

Functions

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

Properties

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 host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

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

The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.

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

Not supported.

Link copied to clipboard

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.

Link copied to clipboard

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

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

The request path of the HTTP health check request. The default value is /.

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

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http