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

HttpsHealthCheckArgs

data class HttpsHealthCheckArgs(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<HttpsHealthCheckArgs>

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

Note: gcp.compute.HttpsHealthCheck 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 HttpsHealthCheck, see:

API documentation
How-to Guides

Adding Health Checks

Example Usage

Https Health Check Basic

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

import pulumi
import pulumi_gcp as gcp
default = gcp.compute.HttpsHealthCheck("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.HttpsHealthCheck("default", new()
    {
        Name = "authentication-health-check",
        RequestPath = "/health_check",
        TimeoutSec = 1,
        CheckIntervalSec = 1,
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewHttpsHealthCheck(ctx, "default", &compute.HttpsHealthCheckArgs{
			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.HttpsHealthCheck;
import com.pulumi.gcp.compute.HttpsHealthCheckArgs;
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 HttpsHealthCheck("default", HttpsHealthCheckArgs.builder()
            .name("authentication-health-check")
            .requestPath("/health_check")
            .timeoutSec(1)
            .checkIntervalSec(1)
            .build());
    }
}

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

Import

HttpsHealthCheck can be imported using any of these accepted formats:

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

$ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default projects/{{project}}/global/httpsHealthChecks/{{name}}

$ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default {{project}}/{{name}}

$ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default {{name}}

Constructors

HttpsHealthCheckArgs

constructor(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)

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 HTTPS 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 HTTPS health check request. The default value is 443.

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

Functions

toJava

open override fun toJava(): HttpsHealthCheckArgs