Google Cloud Classic v7.2.2, Jan 1 01

Google Cloud Classic v7.2.2 published on Monday, Jan 1, 0001 by Pulumi

gcp.compute.HttpHealthCheck

Explore with Pulumi AI

Google Cloud Classic v7.2.2 published on Monday, Jan 1, 0001 by Pulumi

pulumi/pulumi-gcp

Example Usage

Http Health Check Basic

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()
    {
        CheckIntervalSec = 1,
        RequestPath = "/health_check",
        TimeoutSec = 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{
			CheckIntervalSec: pulumi.Int(1),
			RequestPath:      pulumi.String("/health_check"),
			TimeoutSec:       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()        
            .checkIntervalSec(1)
            .requestPath("/health_check")
            .timeoutSec(1)
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.HttpHealthCheck("default",
    check_interval_sec=1,
    request_path="/health_check",
    timeout_sec=1)

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.compute.HttpHealthCheck("default", {
    checkIntervalSec: 1,
    requestPath: "/health_check",
    timeoutSec: 1,
});

resources:
  default:
    type: gcp:compute:HttpHealthCheck
    properties:
      checkIntervalSec: 1
      requestPath: /health_check
      timeoutSec: 1

Create HttpHealthCheck Resource

new HttpHealthCheck(name: string, args?: HttpHealthCheckArgs, opts?: CustomResourceOptions);

@overload
def HttpHealthCheck(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    check_interval_sec: Optional[int] = None,
                    description: Optional[str] = None,
                    healthy_threshold: Optional[int] = None,
                    host: Optional[str] = None,
                    name: Optional[str] = None,
                    port: Optional[int] = None,
                    project: Optional[str] = None,
                    request_path: Optional[str] = None,
                    timeout_sec: Optional[int] = None,
                    unhealthy_threshold: Optional[int] = None)
@overload
def HttpHealthCheck(resource_name: str,
                    args: Optional[HttpHealthCheckArgs] = None,
                    opts: Optional[ResourceOptions] = None)

func NewHttpHealthCheck(ctx *Context, name string, args *HttpHealthCheckArgs, opts ...ResourceOption) (*HttpHealthCheck, error)

public HttpHealthCheck(string name, HttpHealthCheckArgs? args = null, CustomResourceOptions? opts = null)

public HttpHealthCheck(String name, HttpHealthCheckArgs args)
public HttpHealthCheck(String name, HttpHealthCheckArgs args, CustomResourceOptions options)

type: gcp:compute:HttpHealthCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HttpHealthCheckArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args HttpHealthCheckArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HttpHealthCheckArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HttpHealthCheckArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args HttpHealthCheckArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

HttpHealthCheck Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The HttpHealthCheck resource accepts the following input properties:

CheckIntervalSec int: How often (in seconds) to send a health check. The default value is 5 seconds.
Description string: An optional description of this resource. Provide this property when you create the resource.
HealthyThreshold int: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Host 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.
Name 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 int: The TCP port number for the HTTP health check request. The default value is 80.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequestPath string: The request path of the HTTP health check request. The default value is /.
TimeoutSec 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 int: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

CheckIntervalSec int: How often (in seconds) to send a health check. The default value is 5 seconds.
Description string: An optional description of this resource. Provide this property when you create the resource.
HealthyThreshold int: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Host 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.
Name 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 int: The TCP port number for the HTTP health check request. The default value is 80.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequestPath string: The request path of the HTTP health check request. The default value is /.
TimeoutSec 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 int: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

checkIntervalSec Integer: How often (in seconds) to send a health check. The default value is 5 seconds.
description String: An optional description of this resource. Provide this property when you create the resource.
healthyThreshold Integer: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host 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.
name 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 Integer: The TCP port number for the HTTP health check request. The default value is 80.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requestPath String: The request path of the HTTP health check request. The default value is /.
timeoutSec Integer: 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 Integer: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

checkIntervalSec number: How often (in seconds) to send a health check. The default value is 5 seconds.
description string: An optional description of this resource. Provide this property when you create the resource.
healthyThreshold number: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host 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.
name 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 number: The TCP port number for the HTTP health check request. The default value is 80.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requestPath string: The request path of the HTTP health check request. The default value is /.
timeoutSec number: 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 number: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

check_interval_sec int: How often (in seconds) to send a health check. The default value is 5 seconds.
description str: An optional description of this resource. Provide this property when you create the resource.
healthy_threshold int: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host str: 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 str: 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 int: The TCP port number for the HTTP health check request. The default value is 80.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
request_path str: The request path of the HTTP health check request. The default value is /.
timeout_sec 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.
unhealthy_threshold int: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

checkIntervalSec Number: How often (in seconds) to send a health check. The default value is 5 seconds.
description String: An optional description of this resource. Provide this property when you create the resource.
healthyThreshold Number: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host 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.
name 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 Number: The TCP port number for the HTTP health check request. The default value is 80.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requestPath String: The request path of the HTTP health check request. The default value is /.
timeoutSec Number: 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 Number: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Outputs

All input properties are implicitly available as output properties. Additionally, the HttpHealthCheck resource produces the following output properties:

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

creationTimestamp String: Creation timestamp in RFC3339 text format.
id String: The provider-assigned unique ID for this managed resource.
selfLink String: The URI of the created resource.

creationTimestamp string: Creation timestamp in RFC3339 text format.
id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

creation_timestamp str: Creation timestamp in RFC3339 text format.
id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

creationTimestamp String: Creation timestamp in RFC3339 text format.
id String: The provider-assigned unique ID for this managed resource.
selfLink String: The URI of the created resource.

Look up Existing HttpHealthCheck Resource

Get an existing HttpHealthCheck resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HttpHealthCheckState, opts?: CustomResourceOptions): HttpHealthCheck

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        check_interval_sec: Optional[int] = None,
        creation_timestamp: Optional[str] = None,
        description: Optional[str] = None,
        healthy_threshold: Optional[int] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        project: Optional[str] = None,
        request_path: Optional[str] = None,
        self_link: Optional[str] = None,
        timeout_sec: Optional[int] = None,
        unhealthy_threshold: Optional[int] = None) -> HttpHealthCheck

func GetHttpHealthCheck(ctx *Context, name string, id IDInput, state *HttpHealthCheckState, opts ...ResourceOption) (*HttpHealthCheck, error)

public static HttpHealthCheck Get(string name, Input<string> id, HttpHealthCheckState? state, CustomResourceOptions? opts = null)

public static HttpHealthCheck get(String name, Output<String> id, HttpHealthCheckState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CheckIntervalSec int: How often (in seconds) to send a health check. The default value is 5 seconds.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource. Provide this property when you create the resource.
HealthyThreshold int: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Host 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.
Name 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 int: The TCP port number for the HTTP health check request. The default value is 80.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequestPath string: The request path of the HTTP health check request. The default value is /.
SelfLink string: The URI of the created resource.
TimeoutSec 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 int: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

CheckIntervalSec int: How often (in seconds) to send a health check. The default value is 5 seconds.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource. Provide this property when you create the resource.
HealthyThreshold int: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Host 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.
Name 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 int: The TCP port number for the HTTP health check request. The default value is 80.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RequestPath string: The request path of the HTTP health check request. The default value is /.
SelfLink string: The URI of the created resource.
TimeoutSec 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 int: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

checkIntervalSec Integer: How often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestamp String: Creation timestamp in RFC3339 text format.
description String: An optional description of this resource. Provide this property when you create the resource.
healthyThreshold Integer: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host 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.
name 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 Integer: The TCP port number for the HTTP health check request. The default value is 80.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requestPath String: The request path of the HTTP health check request. The default value is /.
selfLink String: The URI of the created resource.
timeoutSec Integer: 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 Integer: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

checkIntervalSec number: How often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: An optional description of this resource. Provide this property when you create the resource.
healthyThreshold number: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host 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.
name 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 number: The TCP port number for the HTTP health check request. The default value is 80.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requestPath string: The request path of the HTTP health check request. The default value is /.
selfLink string: The URI of the created resource.
timeoutSec number: 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 number: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

check_interval_sec int: How often (in seconds) to send a health check. The default value is 5 seconds.
creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: An optional description of this resource. Provide this property when you create the resource.
healthy_threshold int: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host str: 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 str: 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 int: The TCP port number for the HTTP health check request. The default value is 80.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
request_path str: The request path of the HTTP health check request. The default value is /.
self_link str: The URI of the created resource.
timeout_sec 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.
unhealthy_threshold int: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

checkIntervalSec Number: How often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestamp String: Creation timestamp in RFC3339 text format.
description String: An optional description of this resource. Provide this property when you create the resource.
healthyThreshold Number: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host 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.
name 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 Number: The TCP port number for the HTTP health check request. The default value is 80.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
requestPath String: The request path of the HTTP health check request. The default value is /.
selfLink String: The URI of the created resource.
timeoutSec Number: 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 Number: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Import

HttpHealthCheck can be imported using any of these accepted formats* projects/{{project}}/global/httpHealthChecks/{{name}} * {{project}}/{{name}} * {{name}} In Terraform v1.5.0 and later, use an import block to import HttpHealthCheck using one of the formats above. For exampletf import {

id = “projects/{{project}}/global/httpHealthChecks/{{name}}”

to = google_compute_http_health_check.default }

 $ pulumi import gcp:compute/httpHealthCheck:HttpHealthCheck When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), 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}}

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud Classic v7.2.2 published on Monday, Jan 1, 0001 by Pulumi

pulumi/pulumi-gcp

gcp.compute.HttpHealthCheck

On this page

On this page

Example Usage

Http Health Check Basic

Create HttpHealthCheck Resource

HttpHealthCheck Resource Properties

Inputs

Outputs

Look up Existing HttpHealthCheck Resource

Import

Package Details

On this page

On this page