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

     1  ---
     2  layout: "google"
     3  page_title: "Google: google_compute_target_pool"
     4  sidebar_current: "docs-google-compute-target-pool"
     5  description: |-
     6    Manages a Target Pool within GCE.
     7  ---
     8  
     9  # google\_compute\_target\_pool
    10  
    11  Manages a Target Pool within GCE. This is a collection of instances used as
    12  target of a network load balancer (Forwarding Rule). For more information see
    13  [the official
    14  documentation](https://cloud.google.com/compute/docs/load-balancing/network/target-pools)
    15  and [API](https://cloud.google.com/compute/docs/reference/latest/targetPools).
    16  
    17  
    18  ## Example Usage
    19  
    20  ```hcl
    21  resource "google_compute_target_pool" "default" {
    22    name = "test"
    23  
    24    instances = [
    25      "us-central1-a/myinstance1",
    26      "us-central1-b/myinstance2",
    27    ]
    28  
    29    health_checks = [
    30      "${google_compute_http_health_check.default.name}",
    31    ]
    32  }
    33  ```
    34  
    35  ## Argument Reference
    36  
    37  The following arguments are supported:
    38  
    39  * `name` - (Required) A unique name for the resource, required by GCE. Changing
    40      this forces a new resource to be created.
    41  
    42  - - -
    43  
    44  * `backup_pool` - (Optional) URL to the backup target pool. Must also set
    45      failover\_ratio.
    46  
    47  * `description` - (Optional) Textual description field.
    48  
    49  * `failover_ratio` - (Optional) Ratio (0 to 1) of failed nodes before using the
    50      backup pool (which must also be set).
    51  
    52  * `health_checks` - (Optional) List of zero or one healthcheck names.
    53  
    54  * `instances` - (Optional) List of instances in the pool. They can be given as
    55      URLs, or in the form of "zone/name". Note that the instances need not exist
    56      at the time of target pool creation, so there is no need to use the
    57      Terraform interpolators to create a dependency on the instances from the
    58      target pool.
    59  
    60  * `project` - (Optional) The project in which the resource belongs. If it
    61      is not provided, the provider project is used.
    62  
    63  * `region` - (Optional) Where the target pool resides. Defaults to project
    64      region.
    65  
    66  * `session_affinity` - (Optional) How to distribute load. Options are "NONE" (no
    67      affinity). "CLIENT\_IP" (hash of the source/dest addresses / ports), and
    68      "CLIENT\_IP\_PROTO" also includes the protocol (default "NONE").
    69  
    70  ## Attributes Reference
    71  
    72  In addition to the arguments listed above, the following computed attributes are
    73  exported:
    74  
    75  * `self_link` - The URI of the created resource.