2015-08-20 19:53:23 +00:00
---
layout: "google"
page_title: "Google: google_compute_backend_service"
2015-10-23 14:10:41 +00:00
sidebar_current: "docs-google-compute-backend-service"
2015-08-20 19:53:23 +00:00
description: |-
Creates a Backend Service resource for Google Compute Engine.
---
# google\_compute\_backend\_service
2015-09-08 10:57:51 +00:00
A Backend Service defines a group of virtual machines that will serve traffic for load balancing.
2015-08-20 19:53:23 +00:00
## Example Usage
2016-04-10 21:34:15 +00:00
```js
2015-08-20 19:53:23 +00:00
resource "google_compute_backend_service" "foobar" {
2016-04-10 21:34:15 +00:00
name = "blablah"
description = "Hello World 1234"
port_name = "http"
protocol = "HTTP"
timeout_sec = 10
backend {
group = "${google_compute_instance_group_manager.foo.instance_group}"
}
health_checks = ["${google_compute_http_health_check.default.self_link}"]
2015-08-20 19:53:23 +00:00
}
2015-09-08 10:57:51 +00:00
resource "google_compute_instance_group_manager" "foo" {
2016-04-10 21:34:15 +00:00
name = "terraform-test"
instance_template = "${google_compute_instance_template.foobar.self_link}"
base_instance_name = "foobar"
zone = "us-central1-f"
target_size = 1
2015-09-08 10:57:51 +00:00
}
resource "google_compute_instance_template" "foobar" {
2016-04-10 21:34:15 +00:00
name = "terraform-test"
machine_type = "n1-standard-1"
network_interface {
network = "default"
}
disk {
source_image = "debian-7-wheezy-v20160301"
auto_delete = true
boot = true
}
2015-09-08 10:57:51 +00:00
}
2015-08-20 19:53:23 +00:00
resource "google_compute_http_health_check" "default" {
2016-04-10 21:34:15 +00:00
name = "test"
request_path = "/"
check_interval_sec = 1
timeout_sec = 1
2015-08-20 19:53:23 +00:00
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The name of the backend service.
2016-04-10 21:34:15 +00:00
2015-08-20 19:53:23 +00:00
* `health_checks` - (Required) Specifies a list of HTTP health check objects
for checking the health of the backend service.
2016-04-10 21:34:15 +00:00
- - -
* `backend` - (Optional) The list of backends that serve this BackendService.
See *Backend* below.
2015-08-20 19:53:23 +00:00
* `description` - (Optional) The textual description for the backend service.
2016-04-10 21:34:15 +00:00
* `port_name` - (Optional) The name of a service that has been added to an
instance group in this backend. See [related docs ](https://cloud.google.com/compute/docs/instance-groups/#specifying_service_endpoints ) for details. Defaults to http.
* `project` - (Optional) The project in which the resource belongs. If it
is not provided, the provider project is used.
* `protocol` - (Optional) The protocol for incoming requests. Defaults to
`HTTP` .
* `region` - (Optional) The Region in which the created address should reside.
If it is not provided, the provider region is used.
2015-08-20 19:53:23 +00:00
* `timeout_sec` - (Optional) The number of secs to wait for a backend to respond
2016-04-10 21:34:15 +00:00
to a request before considering the request failed. Defaults to `30` .
2015-08-20 19:53:23 +00:00
**Backend** supports the following attributes:
2016-04-10 21:34:15 +00:00
* `group` - (Required) The name or URI of a Compute Engine instance group
(`google_compute_instance_group_manager.xyz.instance_group`) that can
receive traffic.
* `balancing_mode` - (Optional) Defines the strategy for balancing load.
Defaults to `UTILIZATION`
* `capacity_scaler` - (Optional) A float in the range [0, 1.0] that scales the
maximum parameters for the group (e.g., max rate). A value of 0.0 will cause
no requests to be sent to the group (i.e., it adds the group in a drained
state). The default is 1.0.
2015-08-20 19:53:23 +00:00
* `description` - (Optional) Textual description for the backend.
2016-04-10 21:34:15 +00:00
* `max_rate` - (Optional) Maximum requests per second (RPS) that the group can
handle.
* `max_rate_per_instance` - (Optional) The maximum per-instance requests per
second (RPS).
* `max_utilization` - (Optional) The target CPU utilization for the group as a
float in the range [0.0, 1.0]. This flag can only be provided when the
balancing mode is `UTILIZATION` . Defaults to `0.8` .
2015-08-20 19:53:23 +00:00
## Attributes Reference
2016-04-10 21:34:15 +00:00
In addition to the arguments listed above, the following computed attributes are
exported:
* `fingerprint` - The fingerprint of the backend service.
2015-08-20 19:53:23 +00:00
* `self_link` - The URI of the created resource.