Google Cloud v8.29.0, May 1 25

Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi

gcp.compute.getRegionBackendService

Explore with Pulumi AI

Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const myBackend = gcp.compute.getRegionBackendService({
    name: "my-backend-service",
    region: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

my_backend = gcp.compute.get_region_backend_service(name="my-backend-service",
    region="us-central1")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupRegionBackendService(ctx, &compute.LookupRegionBackendServiceArgs{
			Name:   "my-backend-service",
			Region: pulumi.StringRef("us-central1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var myBackend = Gcp.Compute.GetRegionBackendService.Invoke(new()
    {
        Name = "my-backend-service",
        Region = "us-central1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetRegionBackendServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myBackend = ComputeFunctions.getRegionBackendService(GetRegionBackendServiceArgs.builder()
            .name("my-backend-service")
            .region("us-central1")
            .build());

    }
}

variables:
  myBackend:
    fn::invoke:
      function: gcp:compute:getRegionBackendService
      arguments:
        name: my-backend-service
        region: us-central1

Using getRegionBackendService

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRegionBackendService(args: GetRegionBackendServiceArgs, opts?: InvokeOptions): Promise<GetRegionBackendServiceResult>
function getRegionBackendServiceOutput(args: GetRegionBackendServiceOutputArgs, opts?: InvokeOptions): Output<GetRegionBackendServiceResult>

def get_region_backend_service(name: Optional[str] = None,
                               project: Optional[str] = None,
                               region: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetRegionBackendServiceResult
def get_region_backend_service_output(name: Optional[pulumi.Input[str]] = None,
                               project: Optional[pulumi.Input[str]] = None,
                               region: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetRegionBackendServiceResult]

func LookupRegionBackendService(ctx *Context, args *LookupRegionBackendServiceArgs, opts ...InvokeOption) (*LookupRegionBackendServiceResult, error)
func LookupRegionBackendServiceOutput(ctx *Context, args *LookupRegionBackendServiceOutputArgs, opts ...InvokeOption) LookupRegionBackendServiceResultOutput

> Note: This function is named LookupRegionBackendService in the Go SDK.

public static class GetRegionBackendService 
{
    public static Task<GetRegionBackendServiceResult> InvokeAsync(GetRegionBackendServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetRegionBackendServiceResult> Invoke(GetRegionBackendServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRegionBackendServiceResult> getRegionBackendService(GetRegionBackendServiceArgs args, InvokeOptions options)
public static Output<GetRegionBackendServiceResult> getRegionBackendService(GetRegionBackendServiceArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:compute/getRegionBackendService:getRegionBackendService
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the regional backend service.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region where the backend service resides.

Name string: The name of the regional backend service.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region where the backend service resides.

name String: The name of the regional backend service.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region String: The region where the backend service resides.

name string: The name of the regional backend service.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: The region where the backend service resides.

name str: The name of the regional backend service.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: The region where the backend service resides.

name String: The name of the regional backend service.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region String: The region where the backend service resides.

getRegionBackendService Result

The following output properties are available:

AffinityCookieTtlSec int
Backends List<GetRegionBackendServiceBackend>
CdnPolicies List<GetRegionBackendServiceCdnPolicy>
CircuitBreakers List<GetRegionBackendServiceCircuitBreaker>
ConnectionDrainingTimeoutSec int
ConnectionTrackingPolicies List<GetRegionBackendServiceConnectionTrackingPolicy>
ConsistentHashes List<GetRegionBackendServiceConsistentHash>
CreationTimestamp string
CustomMetrics List<GetRegionBackendServiceCustomMetric>
Description string
EnableCdn bool
FailoverPolicies List<GetRegionBackendServiceFailoverPolicy>
Fingerprint string
GeneratedId int
HealthChecks List<string>
Iaps List<GetRegionBackendServiceIap>
Id string: The provider-assigned unique ID for this managed resource.
IpAddressSelectionPolicy string
LoadBalancingScheme string
LocalityLbPolicy string
LogConfigs List<GetRegionBackendServiceLogConfig>
Name string
Network string
OutlierDetections List<GetRegionBackendServiceOutlierDetection>
PortName string
Protocol string
SecurityPolicy string
SelfLink string
SessionAffinity string
StrongSessionAffinityCookies List<GetRegionBackendServiceStrongSessionAffinityCooky>
Subsettings List<GetRegionBackendServiceSubsetting>
TimeoutSec int
Project string
Region string

AffinityCookieTtlSec int
Backends []GetRegionBackendServiceBackend
CdnPolicies []GetRegionBackendServiceCdnPolicy
CircuitBreakers []GetRegionBackendServiceCircuitBreaker
ConnectionDrainingTimeoutSec int
ConnectionTrackingPolicies []GetRegionBackendServiceConnectionTrackingPolicy
ConsistentHashes []GetRegionBackendServiceConsistentHash
CreationTimestamp string
CustomMetrics []GetRegionBackendServiceCustomMetric
Description string
EnableCdn bool
FailoverPolicies []GetRegionBackendServiceFailoverPolicy
Fingerprint string
GeneratedId int
HealthChecks []string
Iaps []GetRegionBackendServiceIap
Id string: The provider-assigned unique ID for this managed resource.
IpAddressSelectionPolicy string
LoadBalancingScheme string
LocalityLbPolicy string
LogConfigs []GetRegionBackendServiceLogConfig
Name string
Network string
OutlierDetections []GetRegionBackendServiceOutlierDetection
PortName string
Protocol string
SecurityPolicy string
SelfLink string
SessionAffinity string
StrongSessionAffinityCookies []GetRegionBackendServiceStrongSessionAffinityCooky
Subsettings []GetRegionBackendServiceSubsetting
TimeoutSec int
Project string
Region string

affinityCookieTtlSec Integer
backends List<GetRegionBackendServiceBackend>
cdnPolicies List<GetRegionBackendServiceCdnPolicy>
circuitBreakers List<GetRegionBackendServiceCircuitBreaker>
connectionDrainingTimeoutSec Integer
connectionTrackingPolicies List<GetRegionBackendServiceConnectionTrackingPolicy>
consistentHashes List<GetRegionBackendServiceConsistentHash>
creationTimestamp String
customMetrics List<GetRegionBackendServiceCustomMetric>
description String
enableCdn Boolean
failoverPolicies List<GetRegionBackendServiceFailoverPolicy>
fingerprint String
generatedId Integer
healthChecks List<String>
iaps List<GetRegionBackendServiceIap>
id String: The provider-assigned unique ID for this managed resource.
ipAddressSelectionPolicy String
loadBalancingScheme String
localityLbPolicy String
logConfigs List<GetRegionBackendServiceLogConfig>
name String
network String
outlierDetections List<GetRegionBackendServiceOutlierDetection>
portName String
protocol String
securityPolicy String
selfLink String
sessionAffinity String
strongSessionAffinityCookies List<GetRegionBackendServiceStrongSessionAffinityCooky>
subsettings List<GetRegionBackendServiceSubsetting>
timeoutSec Integer
project String
region String

affinityCookieTtlSec number
backends GetRegionBackendServiceBackend[]
cdnPolicies GetRegionBackendServiceCdnPolicy[]
circuitBreakers GetRegionBackendServiceCircuitBreaker[]
connectionDrainingTimeoutSec number
connectionTrackingPolicies GetRegionBackendServiceConnectionTrackingPolicy[]
consistentHashes GetRegionBackendServiceConsistentHash[]
creationTimestamp string
customMetrics GetRegionBackendServiceCustomMetric[]
description string
enableCdn boolean
failoverPolicies GetRegionBackendServiceFailoverPolicy[]
fingerprint string
generatedId number
healthChecks string[]
iaps GetRegionBackendServiceIap[]
id string: The provider-assigned unique ID for this managed resource.
ipAddressSelectionPolicy string
loadBalancingScheme string
localityLbPolicy string
logConfigs GetRegionBackendServiceLogConfig[]
name string
network string
outlierDetections GetRegionBackendServiceOutlierDetection[]
portName string
protocol string
securityPolicy string
selfLink string
sessionAffinity string
strongSessionAffinityCookies GetRegionBackendServiceStrongSessionAffinityCooky[]
subsettings GetRegionBackendServiceSubsetting[]
timeoutSec number
project string
region string

affinity_cookie_ttl_sec int
backends Sequence[GetRegionBackendServiceBackend]
cdn_policies Sequence[GetRegionBackendServiceCdnPolicy]
circuit_breakers Sequence[GetRegionBackendServiceCircuitBreaker]
connection_draining_timeout_sec int
connection_tracking_policies Sequence[GetRegionBackendServiceConnectionTrackingPolicy]
consistent_hashes Sequence[GetRegionBackendServiceConsistentHash]
creation_timestamp str
custom_metrics Sequence[GetRegionBackendServiceCustomMetric]
description str
enable_cdn bool
failover_policies Sequence[GetRegionBackendServiceFailoverPolicy]
fingerprint str
generated_id int
health_checks Sequence[str]
iaps Sequence[GetRegionBackendServiceIap]
id str: The provider-assigned unique ID for this managed resource.
ip_address_selection_policy str
load_balancing_scheme str
locality_lb_policy str
log_configs Sequence[GetRegionBackendServiceLogConfig]
name str
network str
outlier_detections Sequence[GetRegionBackendServiceOutlierDetection]
port_name str
protocol str
security_policy str
self_link str
session_affinity str
strong_session_affinity_cookies Sequence[GetRegionBackendServiceStrongSessionAffinityCooky]
subsettings Sequence[GetRegionBackendServiceSubsetting]
timeout_sec int
project str
region str

affinityCookieTtlSec Number
backends List<Property Map>
cdnPolicies List<Property Map>
circuitBreakers List<Property Map>
connectionDrainingTimeoutSec Number
connectionTrackingPolicies List<Property Map>
consistentHashes List<Property Map>
creationTimestamp String
customMetrics List<Property Map>
description String
enableCdn Boolean
failoverPolicies List<Property Map>
fingerprint String
generatedId Number
healthChecks List<String>
iaps List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
ipAddressSelectionPolicy String
loadBalancingScheme String
localityLbPolicy String
logConfigs List<Property Map>
name String
network String
outlierDetections List<Property Map>
portName String
protocol String
securityPolicy String
selfLink String
sessionAffinity String
strongSessionAffinityCookies List<Property Map>
subsettings List<Property Map>
timeoutSec Number
project String
region String

Supporting Types

GetRegionBackendServiceBackend

BalancingMode string

Specifies the balancing mode for this backend.

See the Backend Services Overview for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION", "CUSTOM_METRICS"]

CapacityScaler double

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].

CustomMetrics List<GetRegionBackendServiceBackendCustomMetric>

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode.

Description string

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

Failover bool

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

Group 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.

MaxConnections int

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.

MaxConnectionsPerEndpoint int

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.

MaxConnectionsPerInstance int

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

MaxRate int

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.

MaxRatePerEndpoint double

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.

MaxRatePerInstance double

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.

MaxUtilization double

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.

BalancingMode string

Specifies the balancing mode for this backend.

See the Backend Services Overview for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION", "CUSTOM_METRICS"]

CapacityScaler float64

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

CustomMetrics []GetRegionBackendServiceBackendCustomMetric

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode.

Description string

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

Failover bool

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

Group string

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.

MaxConnections int

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.

MaxConnectionsPerEndpoint int

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

MaxConnectionsPerInstance int

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

MaxRate int

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.

MaxRatePerEndpoint float64

MaxRatePerInstance float64

MaxUtilization float64

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.

balancingMode String

Specifies the balancing mode for this backend.

See the Backend Services Overview for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION", "CUSTOM_METRICS"]

capacityScaler Double

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

customMetrics List<GetRegionBackendServiceBackendCustomMetric>

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode.

description String

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

failover Boolean

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

group String

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.

maxConnections Integer

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.

maxConnectionsPerEndpoint Integer

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

maxConnectionsPerInstance Integer

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

maxRate Integer

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.

maxRatePerEndpoint Double

maxRatePerInstance Double

maxUtilization Double

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.

balancingMode string

Specifies the balancing mode for this backend.

See the Backend Services Overview for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION", "CUSTOM_METRICS"]

capacityScaler number

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

customMetrics GetRegionBackendServiceBackendCustomMetric[]

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode.

description string

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

failover boolean

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

group string

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.

maxConnections number

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.

maxConnectionsPerEndpoint number

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

maxConnectionsPerInstance number

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

maxRate number

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.

maxRatePerEndpoint number

maxRatePerInstance number

maxUtilization number

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.

balancing_mode str

Specifies the balancing mode for this backend.

See the Backend Services Overview for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION", "CUSTOM_METRICS"]

capacity_scaler float

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

custom_metrics Sequence[GetRegionBackendServiceBackendCustomMetric]

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode.

description str

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

failover bool

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

group str

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.

max_connections int

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.

max_connections_per_endpoint int

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

max_connections_per_instance int

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

max_rate int

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.

max_rate_per_endpoint float

max_rate_per_instance float

max_utilization float

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.

balancingMode String

Specifies the balancing mode for this backend.

See the Backend Services Overview for an explanation of load balancing modes. Default value: "UTILIZATION" Possible values: ["UTILIZATION", "RATE", "CONNECTION", "CUSTOM_METRICS"]

capacityScaler Number

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

customMetrics List<Property Map>

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode.

description String

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

failover Boolean

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

group String

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.

maxConnections Number

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.

maxConnectionsPerEndpoint Number

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

maxConnectionsPerInstance Number

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

maxRate Number

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.

maxRatePerEndpoint Number

maxRatePerInstance Number

maxUtilization Number

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.

GetRegionBackendServiceBackendCustomMetric

DryRun bool: If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
MaxUtilization double: Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
Name string: The name of the regional backend service.

DryRun bool: If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
MaxUtilization float64: Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
Name string: The name of the regional backend service.

dryRun Boolean: If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
maxUtilization Double: Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
name String: The name of the regional backend service.

dryRun boolean: If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
maxUtilization number: Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
name string: The name of the regional backend service.

dry_run bool: If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
max_utilization float: Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
name str: The name of the regional backend service.

dryRun Boolean: If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
maxUtilization Number: Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
name String: The name of the regional backend service.

GetRegionBackendServiceCdnPolicy

CacheKeyPolicies List<GetRegionBackendServiceCdnPolicyCacheKeyPolicy>

The CacheKeyPolicy for this CdnPolicy.

CacheMode string

Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"]

ClientTtl int

Specifies the maximum allowed TTL for cached content served by this origin.

DefaultTtl int

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

MaxTtl int

Specifies the maximum allowed TTL for cached content served by this origin.

NegativeCaching bool

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

NegativeCachingPolicies List<GetRegionBackendServiceCdnPolicyNegativeCachingPolicy>

Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs.

ServeWhileStale int

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

SignedUrlCacheMaxAgeSec int

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.

When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

CacheKeyPolicies []GetRegionBackendServiceCdnPolicyCacheKeyPolicy

The CacheKeyPolicy for this CdnPolicy.

CacheMode string

ClientTtl int

Specifies the maximum allowed TTL for cached content served by this origin.

DefaultTtl int

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

MaxTtl int

Specifies the maximum allowed TTL for cached content served by this origin.

NegativeCaching bool

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

NegativeCachingPolicies []GetRegionBackendServiceCdnPolicyNegativeCachingPolicy

ServeWhileStale int

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

SignedUrlCacheMaxAgeSec int

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.

cacheKeyPolicies List<GetRegionBackendServiceCdnPolicyCacheKeyPolicy>

The CacheKeyPolicy for this CdnPolicy.

cacheMode String

clientTtl Integer

Specifies the maximum allowed TTL for cached content served by this origin.

defaultTtl Integer

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

maxTtl Integer

Specifies the maximum allowed TTL for cached content served by this origin.

negativeCaching Boolean

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

negativeCachingPolicies List<GetRegionBackendServiceCdnPolicyNegativeCachingPolicy>

serveWhileStale Integer

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

signedUrlCacheMaxAgeSec Integer

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.

cacheKeyPolicies GetRegionBackendServiceCdnPolicyCacheKeyPolicy[]

The CacheKeyPolicy for this CdnPolicy.

cacheMode string

clientTtl number

Specifies the maximum allowed TTL for cached content served by this origin.

defaultTtl number

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

maxTtl number

Specifies the maximum allowed TTL for cached content served by this origin.

negativeCaching boolean

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

negativeCachingPolicies GetRegionBackendServiceCdnPolicyNegativeCachingPolicy[]

serveWhileStale number

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

signedUrlCacheMaxAgeSec number

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.

cache_key_policies Sequence[GetRegionBackendServiceCdnPolicyCacheKeyPolicy]

The CacheKeyPolicy for this CdnPolicy.

cache_mode str

client_ttl int

Specifies the maximum allowed TTL for cached content served by this origin.

default_ttl int

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

max_ttl int

Specifies the maximum allowed TTL for cached content served by this origin.

negative_caching bool

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

negative_caching_policies Sequence[GetRegionBackendServiceCdnPolicyNegativeCachingPolicy]

serve_while_stale int

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

signed_url_cache_max_age_sec int

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.

cacheKeyPolicies List<Property Map>

The CacheKeyPolicy for this CdnPolicy.

cacheMode String

clientTtl Number

Specifies the maximum allowed TTL for cached content served by this origin.

defaultTtl Number

Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age).

maxTtl Number

Specifies the maximum allowed TTL for cached content served by this origin.

negativeCaching Boolean

Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.

negativeCachingPolicies List<Property Map>

serveWhileStale Number

Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache.

signedUrlCacheMaxAgeSec Number

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.

GetRegionBackendServiceCdnPolicyCacheKeyPolicy

IncludeHost bool

If true requests to different hosts will be cached separately.

IncludeNamedCookies List<string>

Names of cookies to include in cache keys.

IncludeProtocol bool

If true, http and https requests will be cached separately.

IncludeQueryString bool

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

QueryStringBlacklists List<string>

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

QueryStringWhitelists List<string>

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

IncludeHost bool

If true requests to different hosts will be cached separately.

IncludeNamedCookies []string

Names of cookies to include in cache keys.

IncludeProtocol bool

If true, http and https requests will be cached separately.

IncludeQueryString bool

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

QueryStringBlacklists []string

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

QueryStringWhitelists []string

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

includeHost Boolean

If true requests to different hosts will be cached separately.

includeNamedCookies List<String>

Names of cookies to include in cache keys.

includeProtocol Boolean

If true, http and https requests will be cached separately.

includeQueryString Boolean

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

queryStringBlacklists List<String>

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

queryStringWhitelists List<String>

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

includeHost boolean

If true requests to different hosts will be cached separately.

includeNamedCookies string[]

Names of cookies to include in cache keys.

includeProtocol boolean

If true, http and https requests will be cached separately.

includeQueryString boolean

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

queryStringBlacklists string[]

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

queryStringWhitelists string[]

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

include_host bool

If true requests to different hosts will be cached separately.

include_named_cookies Sequence[str]

Names of cookies to include in cache keys.

include_protocol bool

If true, http and https requests will be cached separately.

include_query_string bool

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

query_string_blacklists Sequence[str]

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

query_string_whitelists Sequence[str]

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

includeHost Boolean

If true requests to different hosts will be cached separately.

includeNamedCookies List<String>

Names of cookies to include in cache keys.

includeProtocol Boolean

If true, http and https requests will be cached separately.

includeQueryString Boolean

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

queryStringBlacklists List<String>

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

queryStringWhitelists List<String>

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

GetRegionBackendServiceCdnPolicyNegativeCachingPolicy

Code int: The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.
Ttl int: The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

Code int: The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.
Ttl int: The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

code Integer: The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.
ttl Integer: The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

code number: The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.
ttl number: The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

code int: The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.
ttl int: The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

code Number: The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 308, 404, 405, 410, 421, 451 and 501 can be specified as values, and you cannot specify a status code more than once.
ttl Number: The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.

GetRegionBackendServiceCircuitBreaker

ConnectTimeouts List<GetRegionBackendServiceCircuitBreakerConnectTimeout>: The timeout for new network connections to hosts.
MaxConnections int: The maximum number of connections to the backend cluster. Defaults to 1024.
MaxPendingRequests int: The maximum number of pending requests to the backend cluster. Defaults to 1024.
MaxRequests int: The maximum number of parallel requests to the backend cluster. Defaults to 1024.
MaxRequestsPerConnection int: Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
MaxRetries int: The maximum number of parallel retries to the backend cluster. Defaults to 3.

ConnectTimeouts []GetRegionBackendServiceCircuitBreakerConnectTimeout: The timeout for new network connections to hosts.
MaxConnections int: The maximum number of connections to the backend cluster. Defaults to 1024.
MaxPendingRequests int: The maximum number of pending requests to the backend cluster. Defaults to 1024.
MaxRequests int: The maximum number of parallel requests to the backend cluster. Defaults to 1024.
MaxRequestsPerConnection int: Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
MaxRetries int: The maximum number of parallel retries to the backend cluster. Defaults to 3.

connectTimeouts List<GetRegionBackendServiceCircuitBreakerConnectTimeout>: The timeout for new network connections to hosts.
maxConnections Integer: The maximum number of connections to the backend cluster. Defaults to 1024.
maxPendingRequests Integer: The maximum number of pending requests to the backend cluster. Defaults to 1024.
maxRequests Integer: The maximum number of parallel requests to the backend cluster. Defaults to 1024.
maxRequestsPerConnection Integer: Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
maxRetries Integer: The maximum number of parallel retries to the backend cluster. Defaults to 3.

connectTimeouts GetRegionBackendServiceCircuitBreakerConnectTimeout[]: The timeout for new network connections to hosts.
maxConnections number: The maximum number of connections to the backend cluster. Defaults to 1024.
maxPendingRequests number: The maximum number of pending requests to the backend cluster. Defaults to 1024.
maxRequests number: The maximum number of parallel requests to the backend cluster. Defaults to 1024.
maxRequestsPerConnection number: Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
maxRetries number: The maximum number of parallel retries to the backend cluster. Defaults to 3.

connect_timeouts Sequence[GetRegionBackendServiceCircuitBreakerConnectTimeout]: The timeout for new network connections to hosts.
max_connections int: The maximum number of connections to the backend cluster. Defaults to 1024.
max_pending_requests int: The maximum number of pending requests to the backend cluster. Defaults to 1024.
max_requests int: The maximum number of parallel requests to the backend cluster. Defaults to 1024.
max_requests_per_connection int: Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
max_retries int: The maximum number of parallel retries to the backend cluster. Defaults to 3.

connectTimeouts List<Property Map>: The timeout for new network connections to hosts.
maxConnections Number: The maximum number of connections to the backend cluster. Defaults to 1024.
maxPendingRequests Number: The maximum number of pending requests to the backend cluster. Defaults to 1024.
maxRequests Number: The maximum number of parallel requests to the backend cluster. Defaults to 1024.
maxRequestsPerConnection Number: Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
maxRetries Number: The maximum number of parallel retries to the backend cluster. Defaults to 3.

GetRegionBackendServiceCircuitBreakerConnectTimeout

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Integer: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds Integer: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds Number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

GetRegionBackendServiceConnectionTrackingPolicy

ConnectionPersistenceOnUnhealthyBackends string

Specifies connection persistence when backends are unhealthy.

If set to 'DEFAULT_FOR_PROTOCOL', the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP.

If set to 'NEVER_PERSIST', after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy).

If set to 'ALWAYS_PERSIST', existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value: "DEFAULT_FOR_PROTOCOL" Possible values: ["DEFAULT_FOR_PROTOCOL", "NEVER_PERSIST", "ALWAYS_PERSIST"]

EnableStrongAffinity bool

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

IdleTimeoutSec int

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).

For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours.

For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

TrackingMode string

Specifies the key used for connection tracking. There are two options: 'PER_CONNECTION': The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol.

'PER_SESSION': The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. Default value: "PER_CONNECTION" Possible values: ["PER_CONNECTION", "PER_SESSION"]

ConnectionPersistenceOnUnhealthyBackends string

Specifies connection persistence when backends are unhealthy.

EnableStrongAffinity bool

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

IdleTimeoutSec int

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).

For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours.

For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

TrackingMode string

connectionPersistenceOnUnhealthyBackends String

Specifies connection persistence when backends are unhealthy.

enableStrongAffinity Boolean

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

idleTimeoutSec Integer

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).

For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours.

For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

trackingMode String

connectionPersistenceOnUnhealthyBackends string

Specifies connection persistence when backends are unhealthy.

enableStrongAffinity boolean

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

idleTimeoutSec number

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).

For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours.

For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

trackingMode string

connection_persistence_on_unhealthy_backends str

Specifies connection persistence when backends are unhealthy.

enable_strong_affinity bool

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

idle_timeout_sec int

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).

For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours.

For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

tracking_mode str

connectionPersistenceOnUnhealthyBackends String

Specifies connection persistence when backends are unhealthy.

enableStrongAffinity Boolean

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

idleTimeoutSec Number

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).

For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours.

For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

trackingMode String

GetRegionBackendServiceConsistentHash

HttpCookies List<GetRegionBackendServiceConsistentHashHttpCooky>: Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
HttpHeaderName string: The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
MinimumRingSize int: The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

HttpCookies []GetRegionBackendServiceConsistentHashHttpCooky: Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
HttpHeaderName string: The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
MinimumRingSize int: The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

httpCookies List<GetRegionBackendServiceConsistentHashHttpCooky>: Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
httpHeaderName String: The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
minimumRingSize Integer: The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

httpCookies GetRegionBackendServiceConsistentHashHttpCooky[]: Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
httpHeaderName string: The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
minimumRingSize number: The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

http_cookies Sequence[GetRegionBackendServiceConsistentHashHttpCooky]: Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
http_header_name str: The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
minimum_ring_size int: The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

httpCookies List<Property Map>: Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
httpHeaderName String: The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
minimumRingSize Number: The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

GetRegionBackendServiceConsistentHashHttpCooky

Name string: The name of the regional backend service.
Path string: Path to set for the cookie.
Ttls List<GetRegionBackendServiceConsistentHashHttpCookyTtl>: Lifetime of the cookie.

Name string: The name of the regional backend service.
Path string: Path to set for the cookie.
Ttls []GetRegionBackendServiceConsistentHashHttpCookyTtl: Lifetime of the cookie.

name String: The name of the regional backend service.
path String: Path to set for the cookie.
ttls List<GetRegionBackendServiceConsistentHashHttpCookyTtl>: Lifetime of the cookie.

name string: The name of the regional backend service.
path string: Path to set for the cookie.
ttls GetRegionBackendServiceConsistentHashHttpCookyTtl[]: Lifetime of the cookie.

name str: The name of the regional backend service.
path str: Path to set for the cookie.
ttls Sequence[GetRegionBackendServiceConsistentHashHttpCookyTtl]: Lifetime of the cookie.

name String: The name of the regional backend service.
path String: Path to set for the cookie.
ttls List<Property Map>: Lifetime of the cookie.

GetRegionBackendServiceConsistentHashHttpCookyTtl

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Integer: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds Integer: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds Number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

GetRegionBackendServiceCustomMetric

DryRun bool: If true, the metric data is not used for load balancing.
Name string: The name of the regional backend service.

DryRun bool: If true, the metric data is not used for load balancing.
Name string: The name of the regional backend service.

dryRun Boolean: If true, the metric data is not used for load balancing.
name String: The name of the regional backend service.

dryRun boolean: If true, the metric data is not used for load balancing.
name string: The name of the regional backend service.

dry_run bool: If true, the metric data is not used for load balancing.
name str: The name of the regional backend service.

dryRun Boolean: If true, the metric data is not used for load balancing.
name String: The name of the regional backend service.

GetRegionBackendServiceFailoverPolicy

DisableConnectionDrainOnFailover bool: On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.
DropTrafficIfUnhealthy bool: This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.
FailoverRatio double: The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

DisableConnectionDrainOnFailover bool: On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.
DropTrafficIfUnhealthy bool: This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.
FailoverRatio float64: The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

disableConnectionDrainOnFailover Boolean: On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.
dropTrafficIfUnhealthy Boolean: This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.
failoverRatio Double: The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

disableConnectionDrainOnFailover boolean: On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.
dropTrafficIfUnhealthy boolean: This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.
failoverRatio number: The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

disable_connection_drain_on_failover bool: On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.
drop_traffic_if_unhealthy bool: This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.
failover_ratio float: The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

disableConnectionDrainOnFailover Boolean: On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.
dropTrafficIfUnhealthy Boolean: This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.
failoverRatio Number: The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

GetRegionBackendServiceIap

Enabled bool: Whether the serving infrastructure will authenticate and authorize all incoming requests.
Oauth2ClientId string: OAuth2 Client ID for IAP
Oauth2ClientSecret string: OAuth2 Client Secret for IAP
Oauth2ClientSecretSha256 string: OAuth2 Client Secret SHA-256 for IAP

Enabled bool: Whether the serving infrastructure will authenticate and authorize all incoming requests.
Oauth2ClientId string: OAuth2 Client ID for IAP
Oauth2ClientSecret string: OAuth2 Client Secret for IAP
Oauth2ClientSecretSha256 string: OAuth2 Client Secret SHA-256 for IAP

enabled Boolean: Whether the serving infrastructure will authenticate and authorize all incoming requests.
oauth2ClientId String: OAuth2 Client ID for IAP
oauth2ClientSecret String: OAuth2 Client Secret for IAP
oauth2ClientSecretSha256 String: OAuth2 Client Secret SHA-256 for IAP

enabled boolean: Whether the serving infrastructure will authenticate and authorize all incoming requests.
oauth2ClientId string: OAuth2 Client ID for IAP
oauth2ClientSecret string: OAuth2 Client Secret for IAP
oauth2ClientSecretSha256 string: OAuth2 Client Secret SHA-256 for IAP

enabled bool: Whether the serving infrastructure will authenticate and authorize all incoming requests.
oauth2_client_id str: OAuth2 Client ID for IAP
oauth2_client_secret str: OAuth2 Client Secret for IAP
oauth2_client_secret_sha256 str: OAuth2 Client Secret SHA-256 for IAP

enabled Boolean: Whether the serving infrastructure will authenticate and authorize all incoming requests.
oauth2ClientId String: OAuth2 Client ID for IAP
oauth2ClientSecret String: OAuth2 Client Secret for IAP
oauth2ClientSecretSha256 String: OAuth2 Client Secret SHA-256 for IAP

GetRegionBackendServiceLogConfig

Enable bool: Whether to enable logging for the load balancer traffic served by this backend service.
OptionalFields List<string>: Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
OptionalMode string: Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"]
SampleRate double: This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

Enable bool: Whether to enable logging for the load balancer traffic served by this backend service.
OptionalFields []string: Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
OptionalMode string: Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"]
SampleRate float64: This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

enable Boolean: Whether to enable logging for the load balancer traffic served by this backend service.
optionalFields List<String>: Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
optionalMode String: Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"]
sampleRate Double: This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

enable boolean: Whether to enable logging for the load balancer traffic served by this backend service.
optionalFields string[]: Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
optionalMode string: Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"]
sampleRate number: This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

enable bool: Whether to enable logging for the load balancer traffic served by this backend service.
optional_fields Sequence[str]: Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
optional_mode str: Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"]
sample_rate float: This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

enable Boolean: Whether to enable logging for the load balancer traffic served by this backend service.
optionalFields List<String>: Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
optionalMode String: Specifies the optional logging mode for the load balancer traffic. Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM. Possible values: ["INCLUDE_ALL_OPTIONAL", "EXCLUDE_ALL_OPTIONAL", "CUSTOM"]
sampleRate Number: This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

GetRegionBackendServiceOutlierDetection

BaseEjectionTimes List<GetRegionBackendServiceOutlierDetectionBaseEjectionTime>: The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
ConsecutiveErrors int: Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
ConsecutiveGatewayFailure int: The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
EnforcingConsecutiveErrors int: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
EnforcingConsecutiveGatewayFailure int: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
EnforcingSuccessRate int: The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
Intervals List<GetRegionBackendServiceOutlierDetectionInterval>: Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
MaxEjectionPercent int: Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
SuccessRateMinimumHosts int: The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
SuccessRateRequestVolume int: The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
SuccessRateStdevFactor int: This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

BaseEjectionTimes []GetRegionBackendServiceOutlierDetectionBaseEjectionTime: The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
ConsecutiveErrors int: Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
ConsecutiveGatewayFailure int: The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
EnforcingConsecutiveErrors int: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
EnforcingConsecutiveGatewayFailure int: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
EnforcingSuccessRate int: The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
Intervals []GetRegionBackendServiceOutlierDetectionInterval: Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
MaxEjectionPercent int: Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
SuccessRateMinimumHosts int: The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
SuccessRateRequestVolume int: The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
SuccessRateStdevFactor int: This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

baseEjectionTimes List<GetRegionBackendServiceOutlierDetectionBaseEjectionTime>: The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
consecutiveErrors Integer: Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
consecutiveGatewayFailure Integer: The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
enforcingConsecutiveErrors Integer: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
enforcingConsecutiveGatewayFailure Integer: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
enforcingSuccessRate Integer: The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
intervals List<GetRegionBackendServiceOutlierDetectionInterval>: Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
maxEjectionPercent Integer: Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
successRateMinimumHosts Integer: The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
successRateRequestVolume Integer: The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
successRateStdevFactor Integer: This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

baseEjectionTimes GetRegionBackendServiceOutlierDetectionBaseEjectionTime[]: The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
consecutiveErrors number: Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
consecutiveGatewayFailure number: The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
enforcingConsecutiveErrors number: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
enforcingConsecutiveGatewayFailure number: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
enforcingSuccessRate number: The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
intervals GetRegionBackendServiceOutlierDetectionInterval[]: Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
maxEjectionPercent number: Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
successRateMinimumHosts number: The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
successRateRequestVolume number: The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
successRateStdevFactor number: This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

base_ejection_times Sequence[GetRegionBackendServiceOutlierDetectionBaseEjectionTime]: The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
consecutive_errors int: Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
consecutive_gateway_failure int: The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
enforcing_consecutive_errors int: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
enforcing_consecutive_gateway_failure int: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
enforcing_success_rate int: The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
intervals Sequence[GetRegionBackendServiceOutlierDetectionInterval]: Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
max_ejection_percent int: Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
success_rate_minimum_hosts int: The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
success_rate_request_volume int: The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
success_rate_stdev_factor int: This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

baseEjectionTimes List<Property Map>: The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
consecutiveErrors Number: Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
consecutiveGatewayFailure Number: The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.
enforcingConsecutiveErrors Number: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
enforcingConsecutiveGatewayFailure Number: The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
enforcingSuccessRate Number: The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
intervals List<Property Map>: Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds.
maxEjectionPercent Number: Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
successRateMinimumHosts Number: The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
successRateRequestVolume Number: The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
successRateStdevFactor Number: This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

GetRegionBackendServiceOutlierDetectionBaseEjectionTime

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Integer: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds Integer: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds Number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

GetRegionBackendServiceOutlierDetectionInterval

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Integer: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds Integer: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 'seconds' field and a positive 'nanos' field. Must be from 0 to 999,999,999 inclusive.
seconds Number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

GetRegionBackendServiceStrongSessionAffinityCooky

Name string: The name of the regional backend service.
Path string: Path to set for the cookie.
Ttls List<GetRegionBackendServiceStrongSessionAffinityCookyTtl>: Lifetime of the cookie.

Name string: The name of the regional backend service.
Path string: Path to set for the cookie.
Ttls []GetRegionBackendServiceStrongSessionAffinityCookyTtl: Lifetime of the cookie.

name String: The name of the regional backend service.
path String: Path to set for the cookie.
ttls List<GetRegionBackendServiceStrongSessionAffinityCookyTtl>: Lifetime of the cookie.

name string: The name of the regional backend service.
path string: Path to set for the cookie.
ttls GetRegionBackendServiceStrongSessionAffinityCookyTtl[]: Lifetime of the cookie.

name str: The name of the regional backend service.
path str: Path to set for the cookie.
ttls Sequence[GetRegionBackendServiceStrongSessionAffinityCookyTtl]: Lifetime of the cookie.

name String: The name of the regional backend service.
path String: Path to set for the cookie.
ttls List<Property Map>: Lifetime of the cookie.

GetRegionBackendServiceStrongSessionAffinityCookyTtl

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
Seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Integer: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds Integer: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos int: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds int: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

nanos Number: Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds Number: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

GetRegionBackendServiceSubsetting

Policy string: The algorithm used for subsetting. Possible values: ["CONSISTENT_HASH_SUBSETTING"]

Policy string: The algorithm used for subsetting. Possible values: ["CONSISTENT_HASH_SUBSETTING"]

policy String: The algorithm used for subsetting. Possible values: ["CONSISTENT_HASH_SUBSETTING"]

policy string: The algorithm used for subsetting. Possible values: ["CONSISTENT_HASH_SUBSETTING"]

policy str: The algorithm used for subsetting. Possible values: ["CONSISTENT_HASH_SUBSETTING"]

policy String: The algorithm used for subsetting. Possible values: ["CONSISTENT_HASH_SUBSETTING"]

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.compute.getRegionBackendService

On this page

On this page

Example Usage

Using getRegionBackendService

getRegionBackendService Result

Supporting Types

GetRegionBackendServiceBackend

GetRegionBackendServiceBackendCustomMetric

GetRegionBackendServiceCdnPolicy

GetRegionBackendServiceCdnPolicyCacheKeyPolicy

GetRegionBackendServiceCdnPolicyNegativeCachingPolicy

GetRegionBackendServiceCircuitBreaker

GetRegionBackendServiceCircuitBreakerConnectTimeout

GetRegionBackendServiceConnectionTrackingPolicy

GetRegionBackendServiceConsistentHash

GetRegionBackendServiceConsistentHashHttpCooky

GetRegionBackendServiceConsistentHashHttpCookyTtl

GetRegionBackendServiceCustomMetric

GetRegionBackendServiceFailoverPolicy

GetRegionBackendServiceIap

GetRegionBackendServiceLogConfig

GetRegionBackendServiceOutlierDetection

GetRegionBackendServiceOutlierDetectionBaseEjectionTime

GetRegionBackendServiceOutlierDetectionInterval

GetRegionBackendServiceStrongSessionAffinityCooky

GetRegionBackendServiceStrongSessionAffinityCookyTtl

GetRegionBackendServiceSubsetting

Package Details

On this page

On this page