Compute Engine Target Pool

This table represents the Compute Engine Target Pool resource from Google Cloud Platform.

gcp.compute_target_pool

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
backup_poolcorestringThe 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.
creation_timestampcoretimestamp[Output Only] Creation timestamp in RFC3339 text format.
datadog_display_namecorestring
descriptioncorestringAn optional description of this resource. Provide this property when you create the resource.
failover_ratiocorefloat64This 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.
health_checkscorearray<string>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.
idcorestring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
instancescorearray<string>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.
kindcorestring[Output Only] Type of the resource. Always compute#targetPool for target pools.
labelscorearray<string>
namecorestringName 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.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
regioncorestring[Output Only] URL of the region where the target pool resides.
resource_namecorestring
security_policycorestring[Output Only] The resource URL for the security policy associated with this target pool.
self_linkcorestring[Output Only] Server-defined URL for the resource.
session_affinitycorestringSession 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. Possible values: ['CLIENT_IP', 'CLIENT_IP_NO_DESTINATION', 'CLIENT_IP_PORT_PROTO', 'CLIENT_IP_PROTO', 'GENERATED_COOKIE', 'HEADER_FIELD', 'HTTP_COOKIE', 'NONE', 'STRONG_COOKIE_AFFINITY']. Values descriptions: ["2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", "1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.", "5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.", "3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.", 'Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.', 'The hash is based on a user specified header field.', 'The hash is based on a user provided cookie.', 'No session affinity. Connections from the same client IP may go to any instance in the pool.', 'Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired.']
tagscorehstore