RegionBackendServiceBackendArgs

data class RegionBackendServiceBackendArgs(val balancingMode: Output<String>? = null, val capacityScaler: Output<Double>? = null, val customMetrics: Output<List<RegionBackendServiceBackendCustomMetricArgs>>? = null, val description: Output<String>? = null, val failover: Output<Boolean>? = null, val group: Output<String>, val maxConnections: Output<Int>? = null, val maxConnectionsPerEndpoint: Output<Int>? = null, val maxConnectionsPerInstance: Output<Int>? = null, val maxRate: Output<Int>? = null, val maxRatePerEndpoint: Output<Double>? = null, val maxRatePerInstance: Output<Double>? = null, val maxUtilization: Output<Double>? = null) : ConvertibleToJava<RegionBackendServiceBackendArgs>

Constructors

Link copied to clipboard
constructor(balancingMode: Output<String>? = null, capacityScaler: Output<Double>? = null, customMetrics: Output<List<RegionBackendServiceBackendCustomMetricArgs>>? = null, description: Output<String>? = null, failover: Output<Boolean>? = null, group: Output<String>, maxConnections: Output<Int>? = null, maxConnectionsPerEndpoint: Output<Int>? = null, maxConnectionsPerInstance: Output<Int>? = null, maxRate: Output<Int>? = null, maxRatePerEndpoint: Output<Double>? = null, maxRatePerInstance: Output<Double>? = null, maxUtilization: Output<Double>? = null)

Properties

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

Specifies the balancing mode for this backend. See the Backend Services Overview for an explanation of load balancing modes. Default value is UTILIZATION. Possible values are: UTILIZATION, RATE, CONNECTION, CUSTOM_METRICS.

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

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). ~>NOTE: This field cannot be set for INTERNAL region backend services (default loadBalancingScheme), but is required for non-INTERNAL backend service. The total capacity_scaler for all backends must be non-zero. A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is 0.0,1.0.

Link copied to clipboard

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.

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 failover: Output<Boolean>? = null

This field designates whether this is a failover backend. More than one failover backend can be configured for a given RegionBackendService.

Link copied to clipboard
val group: Output<String>

The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend services cannot mix Instance Group and Network Endpoint Group backends. When the load_balancing_scheme is INTERNAL, only instance groups are supported. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

Link copied to clipboard
val maxConnections: Output<Int>? = null

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. Cannot be set for INTERNAL backend services. For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.

Link copied to clipboard
val maxConnectionsPerEndpoint: Output<Int>? = null

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.

Link copied to clipboard
val maxConnectionsPerInstance: Output<Int>? = null

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

Link copied to clipboard
val maxRate: Output<Int>? = null

The max requests per second (RPS) of the group. Cannot be set for INTERNAL backend services. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.

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

The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. Cannot be set for INTERNAL backend services.

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

The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. Cannot be set for INTERNAL backend services.

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

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is 0.0, 1.0. Cannot be set for INTERNAL backend services.

Functions

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