github.com/turtlemonvh/terraform@v0.6.9-0.20151204001754-8e40b6b855e8/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  ```
    21  resource "google_compute_https_health_check" "default" {
    22  	name = "test"
    23      request_path = "/health_check"
    24      check_interval_sec = 1
    25      timeout_sec = 1
    26  }
    27  ```
    28  
    29  ## Argument Reference
    30  
    31  The following arguments are supported:
    32  
    33  * `check_interval_sec` - (Optional) How often to poll each instance (default 5).
    34  
    35  * `description` - (Optional) Textual description field.
    36  
    37  * `healthy_threshold` - (Optional) Consecutive successes required (default 2).
    38  
    39  * `host` - (Optional) HTTPS host header field (default instance's public ip).
    40  
    41  * `name` - (Required) A unique name for the resource, required by GCE.
    42      Changing this forces a new resource to be created.
    43  
    44  * `port` - (Optional) TCP port to connect to (default 443).
    45  
    46  * `request_path` - (Optional) URL path to query (default /).
    47  
    48  * `timeout_sec` - (Optional) How long before declaring failure (default 5).
    49  
    50  * `unhealthy_threshold` - (Optional) Consecutive failures required (default 2).
    51  
    52  
    53  ## Attributes Reference
    54  
    55  The following attributes are exported:
    56  
    57  * `self_link` - The URL of the created resource.