Class HttpsHealthCheck

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

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Gcp.Compute.HttpsHealthCheck(&quot;default&quot;, new Gcp.Compute.HttpsHealthCheckArgs
    {
        CheckIntervalSec = 1,
        RequestPath = &quot;/health_check&quot;,
        TimeoutSec = 1,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

HttpsHealthCheck

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class HttpsHealthCheck : CustomResource

Constructors

View Source

HttpsHealthCheck(String, HttpsHealthCheckArgs, CustomResourceOptions)

Create a HttpsHealthCheck resource with the given unique name, arguments, and options.

Declaration

public HttpsHealthCheck(string name, HttpsHealthCheckArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
HttpsHealthCheckArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

CheckIntervalSec

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

Declaration

public Output<int?> CheckIntervalSec { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

CreationTimestamp

Creation timestamp in RFC3339 text format.

Declaration

public Output<string> CreationTimestamp { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

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

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

HealthyThreshold

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

Declaration

public Output<int?> HealthyThreshold { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

Host

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.

Declaration

public Output<string> Host { get; }

Property Value

Type	Description
Output<System.String>

View Source

Name

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.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

Port

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

Declaration

public Output<int?> Port { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

Project

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

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

View Source

RequestPath

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

Declaration

public Output<string> RequestPath { get; }

Property Value

Type	Description
Output<System.String>

View Source

SelfLink

The URI of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

View Source

TimeoutSec

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.

Declaration

public Output<int?> TimeoutSec { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

UnhealthyThreshold

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

Declaration

public Output<int?> UnhealthyThreshold { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Methods

View Source

Get(String, Input<String>, HttpsHealthCheckState, CustomResourceOptions)

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

Declaration

public static HttpsHealthCheck Get(string name, Input<string> id, HttpsHealthCheckState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
HttpsHealthCheckState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
HttpsHealthCheck