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

HttpHealthCheck

class HttpHealthCheck : KotlinCustomResource

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

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.compute.HttpHealthCheck("default", {
    name: "authentication-health-check",
    requestPath: "/health_check",
    timeoutSec: 1,
    checkIntervalSec: 1,
});

import pulumi
import pulumi_gcp as gcp
default = gcp.compute.HttpHealthCheck("default",
    name="authentication-health-check",
    request_path="/health_check",
    timeout_sec=1,
    check_interval_sec=1)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Compute.HttpHealthCheck("default", new()
    {
        Name = "authentication-health-check",
        RequestPath = "/health_check",
        TimeoutSec = 1,
        CheckIntervalSec = 1,
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewHttpHealthCheck(ctx, "default", &compute.HttpHealthCheckArgs{
			Name:             pulumi.String("authentication-health-check"),
			RequestPath:      pulumi.String("/health_check"),
			TimeoutSec:       pulumi.Int(1),
			CheckIntervalSec: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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()
            .name("authentication-health-check")
            .requestPath("/health_check")
            .timeoutSec(1)
            .checkIntervalSec(1)
            .build());
    }
}

resources:
  default:
    type: gcp:compute:HttpHealthCheck
    properties:
      name: authentication-health-check
      requestPath: /health_check
      timeoutSec: 1
      checkIntervalSec: 1

Import

HttpHealthCheck can be imported using any of these accepted formats:

projects/{{project}}/global/httpHealthChecks/{{name}}
{{project}}/{{name}}
{{name}} When using the pulumi import command, HttpHealthCheck can be imported using one of the formats above. For example:

$ 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}}

Properties

checkIntervalSec

val checkIntervalSec: Output<Int>?

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

creationTimestamp

val creationTimestamp: Output<String>

Creation timestamp in RFC3339 text format.

description

val description: Output<String>?

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

healthyThreshold

val healthyThreshold: Output<Int>?

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

host

val host: Output<String>?

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.

val id: Output<String>

name

val name: Output<String>

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

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

project

val project: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

requestPath

val requestPath: Output<String>?

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

selfLink

val selfLink: Output<String>

The URI of the created resource.

timeoutSec

val timeoutSec: Output<Int>?

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

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

urn

val urn: Output<String>