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:

API documentation
How-to Guides
- Adding Health Checks

Create a HttpsHealthCheck Resource

new HttpsHealthCheck(name: string, args?: HttpsHealthCheckArgs, opts?: CustomResourceOptions);

def HttpsHealthCheck(resource_name, opts=None, check_interval_sec=None, description=None, healthy_threshold=None, host=None, name=None, port=None, project=None, request_path=None, timeout_sec=None, unhealthy_threshold=None, __props__=None);

func NewHttpsHealthCheck(ctx *Context, name string, args *HttpsHealthCheckArgs, opts ...ResourceOption) (*HttpsHealthCheck, error)

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

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.
opts ResourceOptions: A bag of options that control this 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.

HttpsHealthCheck Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 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 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 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 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 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 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 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 float: 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 float: 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 float: The TCP port number for the HTTPS 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 HTTPS health check request. The default value is /.
timeout_sec float: 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 float: 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.

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.

Look up an 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

static get(resource_name, id, opts=None, check_interval_sec=None, creation_timestamp=None, description=None, healthy_threshold=None, host=None, name=None, port=None, project=None, request_path=None, self_link=None, timeout_sec=None, unhealthy_threshold=None, __props__=None);

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)

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.

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 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 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 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 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 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 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 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 float: 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 float: 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 float: The TCP port number for the HTTPS 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 HTTPS health check request. The default value is /.
self_link str: The URI of the created resource.
timeout_sec float: 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 float: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud