github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/google/r/compute_https_health_check.html.markdown (about)

     1  ---
     2  layout: "google"
     3  page_title: "Google: google_compute_https_health_check"
     4  sidebar_current: "docs-google-compute-https-health-check"
     5  description: |-
     6    Manages an HTTPS Health Check within GCE.
     7  ---
     8  
     9  # google\_compute\_https\_health\_check
    10  
    11  Manages an HTTPS health check within GCE. This is used to monitor instances
    12  behind load balancers. Timeouts or HTTPS errors cause the instance to be
    13  removed from the pool. For more information, see [the official
    14  documentation](https://cloud.google.com/compute/docs/load-balancing/health-checks)
    15  and
    16  [API](https://cloud.google.com/compute/docs/reference/latest/httpsHealthChecks).
    17  
    18  ## Example Usage
    19  
    20  ```hcl
    21  resource "google_compute_https_health_check" "default" {
    22    name         = "test"
    23    request_path = "/health_check"
    24  
    25    timeout_sec        = 1
    26    check_interval_sec = 1
    27  }
    28  ```
    29  
    30  ## Argument Reference
    31  
    32  The following arguments are supported:
    33  
    34  * `name` - (Required) A unique name for the resource, required by GCE. Changing
    35      this forces a new resource to be created.
    36  
    37  - - -
    38  
    39  * `check_interval_sec` - (Optional) How often to poll each instance (default 5).
    40  
    41  * `description` - (Optional) Textual description field.
    42  
    43  * `healthy_threshold` - (Optional) Consecutive successes required (default 2).
    44  
    45  * `host` - (Optional) HTTPS host header field (default instance's public ip).
    46  
    47  * `port` - (Optional) TCP port to connect to (default 443).
    48  
    49  * `project` - (Optional) The project in which the resource belongs. If it
    50      is not provided, the provider project is used.
    51  
    52  * `request_path` - (Optional) URL path to query (default /).
    53  
    54  * `timeout_sec` - (Optional) How long before declaring failure (default 5).
    55  
    56  * `unhealthy_threshold` - (Optional) Consecutive failures required (default 2).
    57  
    58  
    59  ## Attributes Reference
    60  
    61  The following attributes are exported:
    62  
    63  * `self_link` - The URL of the created resource.