1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. HttpsHealthCheck
Google Cloud Classic v7.26.0 published on Friday, Jun 7, 2024 by Pulumi

gcp.compute.HttpsHealthCheck

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.26.0 published on Friday, Jun 7, 2024 by Pulumi

    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:

    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)
    
    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.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
    	})
    }
    
    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 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
    

    Create HttpsHealthCheck Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HttpsHealthCheck(name: string, args?: HttpsHealthCheckArgs, opts?: CustomResourceOptions);
    @overload
    def HttpsHealthCheck(resource_name: str,
                         args: Optional[HttpsHealthCheckArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def HttpsHealthCheck(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)
    func NewHttpsHealthCheck(ctx *Context, name string, args *HttpsHealthCheckArgs, opts ...ResourceOption) (*HttpsHealthCheck, error)
    public HttpsHealthCheck(string name, HttpsHealthCheckArgs? args = null, CustomResourceOptions? opts = null)
    public HttpsHealthCheck(String name, HttpsHealthCheckArgs args)
    public HttpsHealthCheck(String name, HttpsHealthCheckArgs args, CustomResourceOptions options)
    
    type: gcp:compute:HttpsHealthCheck
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args HttpsHealthCheckArgs
    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 HttpsHealthCheckArgs
    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 HttpsHealthCheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HttpsHealthCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HttpsHealthCheckArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var httpsHealthCheckResource = new Gcp.Compute.HttpsHealthCheck("httpsHealthCheckResource", new()
    {
        CheckIntervalSec = 0,
        Description = "string",
        HealthyThreshold = 0,
        Host = "string",
        Name = "string",
        Port = 0,
        Project = "string",
        RequestPath = "string",
        TimeoutSec = 0,
        UnhealthyThreshold = 0,
    });
    
    example, err := compute.NewHttpsHealthCheck(ctx, "httpsHealthCheckResource", &compute.HttpsHealthCheckArgs{
    	CheckIntervalSec:   pulumi.Int(0),
    	Description:        pulumi.String("string"),
    	HealthyThreshold:   pulumi.Int(0),
    	Host:               pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Port:               pulumi.Int(0),
    	Project:            pulumi.String("string"),
    	RequestPath:        pulumi.String("string"),
    	TimeoutSec:         pulumi.Int(0),
    	UnhealthyThreshold: pulumi.Int(0),
    })
    
    var httpsHealthCheckResource = new HttpsHealthCheck("httpsHealthCheckResource", HttpsHealthCheckArgs.builder()
        .checkIntervalSec(0)
        .description("string")
        .healthyThreshold(0)
        .host("string")
        .name("string")
        .port(0)
        .project("string")
        .requestPath("string")
        .timeoutSec(0)
        .unhealthyThreshold(0)
        .build());
    
    https_health_check_resource = gcp.compute.HttpsHealthCheck("httpsHealthCheckResource",
        check_interval_sec=0,
        description="string",
        healthy_threshold=0,
        host="string",
        name="string",
        port=0,
        project="string",
        request_path="string",
        timeout_sec=0,
        unhealthy_threshold=0)
    
    const httpsHealthCheckResource = new gcp.compute.HttpsHealthCheck("httpsHealthCheckResource", {
        checkIntervalSec: 0,
        description: "string",
        healthyThreshold: 0,
        host: "string",
        name: "string",
        port: 0,
        project: "string",
        requestPath: "string",
        timeoutSec: 0,
        unhealthyThreshold: 0,
    });
    
    type: gcp:compute:HttpsHealthCheck
    properties:
        checkIntervalSec: 0
        description: string
        healthyThreshold: 0
        host: string
        name: string
        port: 0
        project: string
        requestPath: string
        timeoutSec: 0
        unhealthyThreshold: 0
    

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

    Get an existing HttpsHealthCheck 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?: HttpsHealthCheckState, opts?: CustomResourceOptions): HttpsHealthCheck
    @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) -> HttpsHealthCheck
    func GetHttpsHealthCheck(ctx *Context, name string, id IDInput, state *HttpsHealthCheckState, opts ...ResourceOption) (*HttpsHealthCheck, error)
    public static HttpsHealthCheck Get(string name, Input<string> id, HttpsHealthCheckState? state, CustomResourceOptions? opts = null)
    public static HttpsHealthCheck get(String name, Output<String> id, HttpsHealthCheckState 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 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 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 HTTPS health check request. The default value is 443.
    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 HTTPS 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 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 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 HTTPS health check request. The default value is 443.
    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 HTTPS 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 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 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 HTTPS health check request. The default value is 443.
    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 HTTPS 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 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 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 HTTPS health check request. The default value is 443.
    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 HTTPS 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 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 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 HTTPS health check request. The default value is 443.
    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 HTTPS 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 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 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 HTTPS health check request. The default value is 443.
    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 HTTPS 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

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

    To learn more about importing existing cloud resources, see Importing resources.

    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.
    gcp logo
    Google Cloud Classic v7.26.0 published on Friday, Jun 7, 2024 by Pulumi