pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/HttpHealthCheckArgs

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 requestPath: Output<String>? = null, val timeoutSec: Output<Int>? = null, val unhealthyThreshold: Output<Int>? = null) : ConvertibleToJava<HttpHealthCheckArgs>

An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.

Note: gcp.compute.HttpHealthCheck is a legacy health check. The newer gcp.compute.HealthCheck should be preferred for all uses except Network Load Balancers which still require the legacy version. To get more information about HttpHealthCheck, see:

API documentation
How-to Guides

Adding Health Checks

Example Usage

Http Health Check Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HttpHealthCheck;
import com.pulumi.gcp.compute.HttpHealthCheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var default_ = new HttpHealthCheck("default", HttpHealthCheckArgs.builder()
            .checkIntervalSec(1)
            .requestPath("/health_check")
            .timeoutSec(1)
            .build());
    }
}

Import

HttpHealthCheck can be imported using any of these accepted formats

$ pulumi import gcp:compute/httpHealthCheck:HttpHealthCheck default projects/{{project}}/global/httpHealthChecks/{{name}}

$ pulumi import gcp:compute/httpHealthCheck:HttpHealthCheck default {{project}}/{{name}}

$ pulumi import gcp:compute/httpHealthCheck:HttpHealthCheck default {{name}}

Constructors

HttpHealthCheckArgs

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, requestPath: Output<String>? = null, timeoutSec: Output<Int>? = null, unhealthyThreshold: Output<Int>? = null)

Functions

toJava

open override fun toJava(): HttpHealthCheckArgs

Properties

checkIntervalSec

val checkIntervalSec: Output<Int>? = null

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

description

val description: Output<String>? = null

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

healthyThreshold

val healthyThreshold: Output<Int>? = null

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

host

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.

name

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? 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.

port

val port: Output<Int>? = null

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

project

val project: Output<String>? = null

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

requestPath

val requestPath: Output<String>? = null

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

timeoutSec

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.

unhealthyThreshold

val unhealthyThreshold: Output<Int>? = null

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