target_pools

Creates, updates, deletes, gets or lists a target_pools resource.

Overview

Name	target_pools
Type	Resource
Id	google.compute.target_pools

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description	string	An optional description of this resource. Provide this property when you create the resource.
backupPool	string	The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
failoverRatio	number	This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
healthChecks	array	The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.
instances	array	A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
kind	string	[Output Only] Type of the resource. Always compute#targetPool for target pools.
region	string	[Output Only] URL of the region where the target pool resides.
securityPolicy	string	[Output Only] The resource URL for the security policy associated with this target pool.
selfLink	string	[Output Only] Server-defined URL for the resource.
sessionAffinity	string	Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
get	SELECT	project, region, targetPool	Returns the specified target pool.
list	SELECT	project, region	Retrieves a list of target pools available to the specified project and region.
insert	INSERT	project, region	Creates a target pool in the specified project and region using the data included in the request.
delete	DELETE	project, region, targetPool	Deletes the specified target pool.
set_backup	EXEC	project, region, targetPool	Changes a backup target pool's configurations.
set_security_policy	EXEC	project, region, targetPool	Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview

SELECT examples

Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
backupPool,
creationTimestamp,
failoverRatio,
healthChecks,
instances,
kind,
region,
securityPolicy,
selfLink,
sessionAffinity
FROM google.compute.target_pools
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new target_pools resource.

All Properties

/*+ create */
INSERT INTO google.compute.target_pools (
project,
region,
name,
description,
region,
healthChecks,
instances,
sessionAffinity,
failoverRatio,
backupPool,
securityPolicy
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ name }}',
'{{ description }}',
'{{ region }}',
'{{ healthChecks }}',
'{{ instances }}',
'{{ sessionAffinity }}',
{{ failoverRatio }},
'{{ backupPool }}',
'{{ securityPolicy }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: region
      value: string
    - name: healthChecks
      value:
        - string
    - name: instances
      value:
        - string
    - name: sessionAffinity
      value: string
    - name: failoverRatio
      value: number
    - name: backupPool
      value: string
    - name: selfLink
      value: string
    - name: securityPolicy
      value: string

DELETE example

Deletes the specified target_pools resource.

/*+ delete */
DELETE FROM google.compute.target_pools
WHERE project = '{{ project }}'
AND region = '{{ region }}'
AND targetPool = '{{ targetPool }}';