Skip to content

googleComputeHttpsHealthCheck

An HttpsHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTPS.

\~> Note: google_compute_https_health_check is a legacy health check. The newer google_compute_health_check should be preferred for all uses except Network Load Balancers which still require the legacy version.

To get more information about HttpsHealthCheck, see:

Open in Cloud Shell

Example Usage - Https Health Check Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.computeHttpsHealthCheck.ComputeHttpsHealthCheck(this, "default", {
  check_interval_sec: 1,
  name: "authentication-health-check",
  request_path: "/health_check",
  timeout_sec: 1,
});

Argument Reference

The following arguments are supported:

  • name - (Required) 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 [aZ]([AZ09]*[aZ09])? 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.

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

  • description - (Optional) An optional description of this resource. Provide this property when you create the resource.

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

  • host - (Optional) 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.

  • port - (Optional) The TCP port number for the HTTPS health check request. The default value is 443.

  • requestPath - (Optional) The request path of the HTTPS health check request. The default value is /.

  • timeoutSec - (Optional) 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 - (Optional) A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/global/httpsHealthChecks/{{name}}

  • creationTimestamp - Creation timestamp in RFC3339 text format.

  • selfLink - The URI of the created resource.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

HttpsHealthCheck can be imported using any of these accepted formats:

$ terraform import google_compute_https_health_check.default projects/{{project}}/global/httpsHealthChecks/{{name}}
$ terraform import google_compute_https_health_check.default {{project}}/{{name}}
$ terraform import google_compute_https_health_check.default {{name}}

User Project Overrides

This resource supports User Project Overrides.