v5.18.0/website/docs/r/compute_https_health_check.html.markdown

---
# ----------------------------------------------------------------------------
#
#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
#
# ----------------------------------------------------------------------------
#
#     This file is automatically generated by Magic Modules and manual
#     changes will be clobbered when the file is regenerated.
#
#     Please read more about how to change this file in
#     .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Compute Engine"
description: |-
  An HttpsHealthCheck resource.
---

# google\_compute\_https\_health\_check

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](/docs/providers/google/r/compute_health_check.html)
should be preferred for all uses except
[Network Load Balancers](https://cloud.google.com/compute/docs/load-balancing/network/)
which still require the legacy version.


To get more information about HttpsHealthCheck, see:

* [API documentation](https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks)
* How-to Guides
    * [Adding Health Checks](https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks)

<div class = "oics-button" style="float: right; margin: 0 0 -15px">
  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=https_health_check_basic&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
  </a>
</div>
## Example Usage - Https Health Check Basic


```hcl
resource "google_compute_https_health_check" "default" {
  name         = "authentication-health-check"
  request_path = "/health_check"

  timeout_sec        = 1
  check_interval_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 `[a-z]([-a-z0-9]*[a-z0-9])?` 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.


- - -


* `check_interval_sec` -
  (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.

* `healthy_threshold` -
  (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.

* `request_path` -
  (Optional)
  The request path of the HTTPS health check request.
  The default value is /.

* `timeout_sec` -
  (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.

* `unhealthy_threshold` -
  (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}}`

* `creation_timestamp` -
  Creation timestamp in RFC3339 text format.
* `self_link` - The URI of the created resource.


## Timeouts

This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-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:

* `projects/{{project}}/global/httpsHealthChecks/{{name}}`
* `{{project}}/{{name}}`
* `{{name}}`


In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import HttpsHealthCheck using one of the formats above. For example:

```tf
import {
  id = "projects/{{project}}/global/httpsHealthChecks/{{name}}"
  to = google_compute_https_health_check.default
}
```

When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), HttpsHealthCheck can be imported using one of the formats above. For example:

```
$ 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](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).