TargetPoolArgs

data class TargetPoolArgs(val backupPool: Output<String>? = null, val description: Output<String>? = null, val failoverRatio: Output<Double>? = null, val healthChecks: Output<List<String>>? = null, val instances: Output<List<String>>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val requestId: Output<String>? = null, val sessionAffinity: Output<TargetPoolSessionAffinity>? = null) : ConvertibleToJava<TargetPoolArgs>

Creates a target pool in the specified project and region using the data included in the request.

Constructors

Link copied to clipboard
fun TargetPoolArgs(backupPool: Output<String>? = null, description: Output<String>? = null, failoverRatio: Output<Double>? = null, healthChecks: Output<List<String>>? = null, instances: Output<List<String>>? = null, name: Output<String>? = null, project: Output<String>? = null, region: Output<String>? = null, requestId: Output<String>? = null, sessionAffinity: Output<TargetPoolSessionAffinity>? = null)

Functions

Link copied to clipboard
open override fun toJava(): TargetPoolArgs

Properties

Link copied to clipboard
val backupPool: Output<String>? = null

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.

Link copied to clipboard
val description: Output<String>? = null

An optional description of this resource. Provide this property when you create the resource.

Link copied to clipboard
val failoverRatio: Output<Double>? = null

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.

Link copied to clipboard
val healthChecks: Output<List<String>>? = null

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.

Link copied to clipboard
val instances: Output<List<String>>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val region: Output<String>? = null
Link copied to clipboard
val requestId: Output<String>? = null

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Link copied to clipboard

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.