HttpHealthCheck class

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:

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/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_httphealthcheck" "default" {
  name               = "authentication-health-check"
  request_path       = "/health_check"
  timeout_sec        = 1
  check_interval_sec = 1
}

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.ArrayList;
import java.util.Arrays;
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}}

Constructors

HttpHealthCheck(String name, {HttpHealthCheckArgs? args, CustomResourceOptions? options}): Creates a new HttpHealthCheck. name The Pulumi resource name. args Arguments used to configure this HttpHealthCheck. The set of arguments for HttpHealthCheck. options Resource options controlling this resource's behavior.
HttpHealthCheck.reference(String urn): Creates a typed reference to an existing HttpHealthCheck resource.

Properties

checkIntervalSec ↔ Output<int?>: How often (in seconds) to send a health check. The default value is 5 seconds.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
creationTimestamp ↔ Output<String>: Creation timestamp in RFC3339 text format.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: An optional description of this resource. Provide this property when you create the resource.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
healthyThreshold ↔ Output<int?>: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
latefinal
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.
latefinal
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
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.
latefinal
port ↔ Output<int?>: The TCP port number for the HTTP health check request. The default value is 80.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
requestPath ↔ Output<String?>: The request path of the HTTP health check request. The default value is /.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selfLink ↔ Output<String>: The URI of the created resource.
latefinal
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.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
unhealthyThreshold ↔ Output<int?>: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {HttpHealthCheckState? state, CustomResourceOptions? options}) → HttpHealthCheck: Gets an existing HttpHealthCheck resource's state with the given name and id.