TargetPool

Manages a Target Pool within GCE. This is a collection of instances used as target of a network load balancer (Forwarding Rule). For more information see the official documentation and API.

Create a TargetPool Resource

new TargetPool(name: string, args?: TargetPoolArgs, opts?: CustomResourceOptions);

def TargetPool(resource_name, opts=None, backup_pool=None, description=None, failover_ratio=None, health_checks=None, instances=None, name=None, project=None, region=None, session_affinity=None, __props__=None);

func NewTargetPool(ctx *Context, name string, args *TargetPoolArgs, opts ...ResourceOption) (*TargetPool, error)

public TargetPool(string name, TargetPoolArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TargetPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TargetPoolArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TargetPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

TargetPool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The TargetPool resource accepts the following input properties:

BackupPool string: URL to the backup target pool. Must also set failover_ratio.
Description string: Textual description field.
FailoverRatio double: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
HealthChecks string: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
Instances List<string>: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
Name string: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Where the target pool resides. Defaults to project region.
SessionAffinity string: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

BackupPool string: URL to the backup target pool. Must also set failover_ratio.
Description string: Textual description field.
FailoverRatio float64: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
HealthChecks string: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
Instances []string: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
Name string: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Where the target pool resides. Defaults to project region.
SessionAffinity string: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

backupPool string: URL to the backup target pool. Must also set failover_ratio.
description string: Textual description field.
failoverRatio number: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
healthChecks string: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
instances string[]: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
name string: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: Where the target pool resides. Defaults to project region.
sessionAffinity string: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

backup_pool str: URL to the backup target pool. Must also set failover_ratio.
description str: Textual description field.
failover_ratio float: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
health_checks str: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
instances List[str]: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
name str: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: Where the target pool resides. Defaults to project region.
session_affinity str: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

Outputs

All input properties are implicitly available as output properties. Additionally, the TargetPool resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

Look up an Existing TargetPool Resource

Get an existing TargetPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TargetPoolState, opts?: CustomResourceOptions): TargetPool

static get(resource_name, id, opts=None, backup_pool=None, description=None, failover_ratio=None, health_checks=None, instances=None, name=None, project=None, region=None, self_link=None, session_affinity=None, __props__=None);

func GetTargetPool(ctx *Context, name string, id IDInput, state *TargetPoolState, opts ...ResourceOption) (*TargetPool, error)

public static TargetPool Get(string name, Input<string> id, TargetPoolState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BackupPool string: URL to the backup target pool. Must also set failover_ratio.
Description string: Textual description field.
FailoverRatio double: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
HealthChecks string: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
Instances List<string>: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
Name string: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Where the target pool resides. Defaults to project region.
SelfLink string: The URI of the created resource.
SessionAffinity string: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

BackupPool string: URL to the backup target pool. Must also set failover_ratio.
Description string: Textual description field.
FailoverRatio float64: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
HealthChecks string: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
Instances []string: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
Name string: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Where the target pool resides. Defaults to project region.
SelfLink string: The URI of the created resource.
SessionAffinity string: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

backupPool string: URL to the backup target pool. Must also set failover_ratio.
description string: Textual description field.
failoverRatio number: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
healthChecks string: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
instances string[]: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
name string: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: Where the target pool resides. Defaults to project region.
selfLink string: The URI of the created resource.
sessionAffinity string: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

backup_pool str: URL to the backup target pool. Must also set failover_ratio.
description str: Textual description field.
failover_ratio float: Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
health_checks str: List of zero or one health check name or self_link. Only legacy gcp.compute.HttpHealthCheck is supported.
instances List[str]: List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use the interpolation to create a dependency on the instances from the target pool.
name str: A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: Where the target pool resides. Defaults to project region.
self_link str: The URI of the created resource.
session_affinity str: How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud