Docs Home
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
gcp.compute.RegionBackendService
Explore with Pulumi AI
- Example Usage
- Region Backend Service Basic
- Region Backend Service External Iap
- Region Backend Service Cache
- Region Backend Service Ilb Round Robin
- Region Backend Service External
- Region Backend Service External Weighted
- Region Backend Service Ilb Ring Hash
- Region Backend Service Ilb Stateful Session Affinity
- Region Backend Service Balancing Mode
- Region Backend Service Connection Tracking
- Region Backend Service Ip Address Selection Policy
- Region Backend Service Ilb Custom Metrics
- Create RegionBackendService Resource
- Constructor syntax
- Constructor example
- RegionBackendService Resource Properties
- Inputs
- Outputs
- Look up Existing RegionBackendService Resource
- Supporting Types
- Import
- Package Details
A Region Backend Service defines a regionally-scoped group of virtual machines that will serve traffic for load balancing.
To get more information about RegionBackendService, see:
- API documentation
- How-to Guides
Example Usage
Region Backend Service Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultHealthCheck = new gcp.compute.HealthCheck("default", {
name: "rbs-health-check",
checkIntervalSec: 1,
timeoutSec: 1,
tcpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
name: "region-service",
region: "us-central1",
healthChecks: defaultHealthCheck.id,
connectionDrainingTimeoutSec: 10,
sessionAffinity: "CLIENT_IP",
});
import pulumi
import pulumi_gcp as gcp
default_health_check = gcp.compute.HealthCheck("default",
name="rbs-health-check",
check_interval_sec=1,
timeout_sec=1,
tcp_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
name="region-service",
region="us-central1",
health_checks=default_health_check.id,
connection_draining_timeout_sec=10,
session_affinity="CLIENT_IP")
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 {
defaultHealthCheck, err := compute.NewHealthCheck(ctx, "default", &compute.HealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
CheckIntervalSec: pulumi.Int(1),
TimeoutSec: pulumi.Int(1),
TcpHealthCheck: &compute.HealthCheckTcpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Name: pulumi.String("region-service"),
Region: pulumi.String("us-central1"),
HealthChecks: defaultHealthCheck.ID(),
ConnectionDrainingTimeoutSec: pulumi.Int(10),
SessionAffinity: pulumi.String("CLIENT_IP"),
})
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 defaultHealthCheck = new Gcp.Compute.HealthCheck("default", new()
{
Name = "rbs-health-check",
CheckIntervalSec = 1,
TimeoutSec = 1,
TcpHealthCheck = new Gcp.Compute.Inputs.HealthCheckTcpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Name = "region-service",
Region = "us-central1",
HealthChecks = defaultHealthCheck.Id,
ConnectionDrainingTimeoutSec = 10,
SessionAffinity = "CLIENT_IP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckTcpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
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) {
var defaultHealthCheck = new HealthCheck("defaultHealthCheck", HealthCheckArgs.builder()
.name("rbs-health-check")
.checkIntervalSec(1)
.timeoutSec(1)
.tcpHealthCheck(HealthCheckTcpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.name("region-service")
.region("us-central1")
.healthChecks(defaultHealthCheck.id())
.connectionDrainingTimeoutSec(10)
.sessionAffinity("CLIENT_IP")
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
name: region-service
region: us-central1
healthChecks: ${defaultHealthCheck.id}
connectionDrainingTimeoutSec: 10
sessionAffinity: CLIENT_IP
defaultHealthCheck:
type: gcp:compute:HealthCheck
name: default
properties:
name: rbs-health-check
checkIntervalSec: 1
timeoutSec: 1
tcpHealthCheck:
port: '80'
Region Backend Service External Iap
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.compute.RegionBackendService("default", {
name: "tf-test-region-service-external",
region: "us-central1",
protocol: "HTTP",
loadBalancingScheme: "EXTERNAL",
iap: {
enabled: true,
oauth2ClientId: "abc",
oauth2ClientSecret: "xyz",
},
});
import pulumi
import pulumi_gcp as gcp
default = gcp.compute.RegionBackendService("default",
name="tf-test-region-service-external",
region="us-central1",
protocol="HTTP",
load_balancing_scheme="EXTERNAL",
iap={
"enabled": True,
"oauth2_client_id": "abc",
"oauth2_client_secret": "xyz",
})
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.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Name: pulumi.String("tf-test-region-service-external"),
Region: pulumi.String("us-central1"),
Protocol: pulumi.String("HTTP"),
LoadBalancingScheme: pulumi.String("EXTERNAL"),
Iap: &compute.RegionBackendServiceIapArgs{
Enabled: pulumi.Bool(true),
Oauth2ClientId: pulumi.String("abc"),
Oauth2ClientSecret: pulumi.String("xyz"),
},
})
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 @default = new Gcp.Compute.RegionBackendService("default", new()
{
Name = "tf-test-region-service-external",
Region = "us-central1",
Protocol = "HTTP",
LoadBalancingScheme = "EXTERNAL",
Iap = new Gcp.Compute.Inputs.RegionBackendServiceIapArgs
{
Enabled = true,
Oauth2ClientId = "abc",
Oauth2ClientSecret = "xyz",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceIapArgs;
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) {
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.name("tf-test-region-service-external")
.region("us-central1")
.protocol("HTTP")
.loadBalancingScheme("EXTERNAL")
.iap(RegionBackendServiceIapArgs.builder()
.enabled(true)
.oauth2ClientId("abc")
.oauth2ClientSecret("xyz")
.build())
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
name: tf-test-region-service-external
region: us-central1
protocol: HTTP
loadBalancingScheme: EXTERNAL
iap:
enabled: true
oauth2ClientId: abc
oauth2ClientSecret: xyz
Region Backend Service Cache
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
name: "rbs-health-check",
region: "us-central1",
httpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
name: "region-service",
region: "us-central1",
healthChecks: defaultRegionHealthCheck.id,
enableCdn: true,
cdnPolicy: {
cacheMode: "CACHE_ALL_STATIC",
defaultTtl: 3600,
clientTtl: 7200,
maxTtl: 10800,
negativeCaching: true,
signedUrlCacheMaxAgeSec: 7200,
},
loadBalancingScheme: "EXTERNAL",
protocol: "HTTP",
});
import pulumi
import pulumi_gcp as gcp
default_region_health_check = gcp.compute.RegionHealthCheck("default",
name="rbs-health-check",
region="us-central1",
http_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
name="region-service",
region="us-central1",
health_checks=default_region_health_check.id,
enable_cdn=True,
cdn_policy={
"cache_mode": "CACHE_ALL_STATIC",
"default_ttl": 3600,
"client_ttl": 7200,
"max_ttl": 10800,
"negative_caching": True,
"signed_url_cache_max_age_sec": 7200,
},
load_balancing_scheme="EXTERNAL",
protocol="HTTP")
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 {
defaultRegionHealthCheck, err := compute.NewRegionHealthCheck(ctx, "default", &compute.RegionHealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
Region: pulumi.String("us-central1"),
HttpHealthCheck: &compute.RegionHealthCheckHttpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Name: pulumi.String("region-service"),
Region: pulumi.String("us-central1"),
HealthChecks: defaultRegionHealthCheck.ID(),
EnableCdn: pulumi.Bool(true),
CdnPolicy: &compute.RegionBackendServiceCdnPolicyArgs{
CacheMode: pulumi.String("CACHE_ALL_STATIC"),
DefaultTtl: pulumi.Int(3600),
ClientTtl: pulumi.Int(7200),
MaxTtl: pulumi.Int(10800),
NegativeCaching: pulumi.Bool(true),
SignedUrlCacheMaxAgeSec: pulumi.Int(7200),
},
LoadBalancingScheme: pulumi.String("EXTERNAL"),
Protocol: pulumi.String("HTTP"),
})
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 defaultRegionHealthCheck = new Gcp.Compute.RegionHealthCheck("default", new()
{
Name = "rbs-health-check",
Region = "us-central1",
HttpHealthCheck = new Gcp.Compute.Inputs.RegionHealthCheckHttpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Name = "region-service",
Region = "us-central1",
HealthChecks = defaultRegionHealthCheck.Id,
EnableCdn = true,
CdnPolicy = new Gcp.Compute.Inputs.RegionBackendServiceCdnPolicyArgs
{
CacheMode = "CACHE_ALL_STATIC",
DefaultTtl = 3600,
ClientTtl = 7200,
MaxTtl = 10800,
NegativeCaching = true,
SignedUrlCacheMaxAgeSec = 7200,
},
LoadBalancingScheme = "EXTERNAL",
Protocol = "HTTP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionHealthCheck;
import com.pulumi.gcp.compute.RegionHealthCheckArgs;
import com.pulumi.gcp.compute.inputs.RegionHealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceCdnPolicyArgs;
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) {
var defaultRegionHealthCheck = new RegionHealthCheck("defaultRegionHealthCheck", RegionHealthCheckArgs.builder()
.name("rbs-health-check")
.region("us-central1")
.httpHealthCheck(RegionHealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.name("region-service")
.region("us-central1")
.healthChecks(defaultRegionHealthCheck.id())
.enableCdn(true)
.cdnPolicy(RegionBackendServiceCdnPolicyArgs.builder()
.cacheMode("CACHE_ALL_STATIC")
.defaultTtl(3600)
.clientTtl(7200)
.maxTtl(10800)
.negativeCaching(true)
.signedUrlCacheMaxAgeSec(7200)
.build())
.loadBalancingScheme("EXTERNAL")
.protocol("HTTP")
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
name: region-service
region: us-central1
healthChecks: ${defaultRegionHealthCheck.id}
enableCdn: true
cdnPolicy:
cacheMode: CACHE_ALL_STATIC
defaultTtl: 3600
clientTtl: 7200
maxTtl: 10800
negativeCaching: true
signedUrlCacheMaxAgeSec: 7200
loadBalancingScheme: EXTERNAL
protocol: HTTP
defaultRegionHealthCheck:
type: gcp:compute:RegionHealthCheck
name: default
properties:
name: rbs-health-check
region: us-central1
httpHealthCheck:
port: 80
Region Backend Service Ilb Round Robin
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const healthCheck = new gcp.compute.HealthCheck("health_check", {
name: "rbs-health-check",
httpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
region: "us-central1",
name: "region-service",
healthChecks: healthCheck.id,
protocol: "HTTP",
loadBalancingScheme: "INTERNAL_MANAGED",
localityLbPolicy: "ROUND_ROBIN",
});
import pulumi
import pulumi_gcp as gcp
health_check = gcp.compute.HealthCheck("health_check",
name="rbs-health-check",
http_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
region="us-central1",
name="region-service",
health_checks=health_check.id,
protocol="HTTP",
load_balancing_scheme="INTERNAL_MANAGED",
locality_lb_policy="ROUND_ROBIN")
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 {
healthCheck, err := compute.NewHealthCheck(ctx, "health_check", &compute.HealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
HttpHealthCheck: &compute.HealthCheckHttpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("region-service"),
HealthChecks: healthCheck.ID(),
Protocol: pulumi.String("HTTP"),
LoadBalancingScheme: pulumi.String("INTERNAL_MANAGED"),
LocalityLbPolicy: pulumi.String("ROUND_ROBIN"),
})
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 healthCheck = new Gcp.Compute.HealthCheck("health_check", new()
{
Name = "rbs-health-check",
HttpHealthCheck = new Gcp.Compute.Inputs.HealthCheckHttpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Region = "us-central1",
Name = "region-service",
HealthChecks = healthCheck.Id,
Protocol = "HTTP",
LoadBalancingScheme = "INTERNAL_MANAGED",
LocalityLbPolicy = "ROUND_ROBIN",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
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) {
var healthCheck = new HealthCheck("healthCheck", HealthCheckArgs.builder()
.name("rbs-health-check")
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.region("us-central1")
.name("region-service")
.healthChecks(healthCheck.id())
.protocol("HTTP")
.loadBalancingScheme("INTERNAL_MANAGED")
.localityLbPolicy("ROUND_ROBIN")
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
region: us-central1
name: region-service
healthChecks: ${healthCheck.id}
protocol: HTTP
loadBalancingScheme: INTERNAL_MANAGED
localityLbPolicy: ROUND_ROBIN
healthCheck:
type: gcp:compute:HealthCheck
name: health_check
properties:
name: rbs-health-check
httpHealthCheck:
port: 80
Region Backend Service External
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
name: "rbs-health-check",
region: "us-central1",
tcpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
region: "us-central1",
name: "region-service",
healthChecks: healthCheck.id,
protocol: "TCP",
loadBalancingScheme: "EXTERNAL",
});
import pulumi
import pulumi_gcp as gcp
health_check = gcp.compute.RegionHealthCheck("health_check",
name="rbs-health-check",
region="us-central1",
tcp_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
region="us-central1",
name="region-service",
health_checks=health_check.id,
protocol="TCP",
load_balancing_scheme="EXTERNAL")
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 {
healthCheck, err := compute.NewRegionHealthCheck(ctx, "health_check", &compute.RegionHealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
Region: pulumi.String("us-central1"),
TcpHealthCheck: &compute.RegionHealthCheckTcpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("region-service"),
HealthChecks: healthCheck.ID(),
Protocol: pulumi.String("TCP"),
LoadBalancingScheme: pulumi.String("EXTERNAL"),
})
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 healthCheck = new Gcp.Compute.RegionHealthCheck("health_check", new()
{
Name = "rbs-health-check",
Region = "us-central1",
TcpHealthCheck = new Gcp.Compute.Inputs.RegionHealthCheckTcpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Region = "us-central1",
Name = "region-service",
HealthChecks = healthCheck.Id,
Protocol = "TCP",
LoadBalancingScheme = "EXTERNAL",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionHealthCheck;
import com.pulumi.gcp.compute.RegionHealthCheckArgs;
import com.pulumi.gcp.compute.inputs.RegionHealthCheckTcpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
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) {
var healthCheck = new RegionHealthCheck("healthCheck", RegionHealthCheckArgs.builder()
.name("rbs-health-check")
.region("us-central1")
.tcpHealthCheck(RegionHealthCheckTcpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.region("us-central1")
.name("region-service")
.healthChecks(healthCheck.id())
.protocol("TCP")
.loadBalancingScheme("EXTERNAL")
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
region: us-central1
name: region-service
healthChecks: ${healthCheck.id}
protocol: TCP
loadBalancingScheme: EXTERNAL
healthCheck:
type: gcp:compute:RegionHealthCheck
name: health_check
properties:
name: rbs-health-check
region: us-central1
tcpHealthCheck:
port: 80
Region Backend Service External Weighted
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
name: "rbs-health-check",
region: "us-central1",
httpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
region: "us-central1",
name: "region-service",
healthChecks: healthCheck.id,
protocol: "TCP",
loadBalancingScheme: "EXTERNAL",
localityLbPolicy: "WEIGHTED_MAGLEV",
});
import pulumi
import pulumi_gcp as gcp
health_check = gcp.compute.RegionHealthCheck("health_check",
name="rbs-health-check",
region="us-central1",
http_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
region="us-central1",
name="region-service",
health_checks=health_check.id,
protocol="TCP",
load_balancing_scheme="EXTERNAL",
locality_lb_policy="WEIGHTED_MAGLEV")
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 {
healthCheck, err := compute.NewRegionHealthCheck(ctx, "health_check", &compute.RegionHealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
Region: pulumi.String("us-central1"),
HttpHealthCheck: &compute.RegionHealthCheckHttpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("region-service"),
HealthChecks: healthCheck.ID(),
Protocol: pulumi.String("TCP"),
LoadBalancingScheme: pulumi.String("EXTERNAL"),
LocalityLbPolicy: pulumi.String("WEIGHTED_MAGLEV"),
})
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 healthCheck = new Gcp.Compute.RegionHealthCheck("health_check", new()
{
Name = "rbs-health-check",
Region = "us-central1",
HttpHealthCheck = new Gcp.Compute.Inputs.RegionHealthCheckHttpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Region = "us-central1",
Name = "region-service",
HealthChecks = healthCheck.Id,
Protocol = "TCP",
LoadBalancingScheme = "EXTERNAL",
LocalityLbPolicy = "WEIGHTED_MAGLEV",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionHealthCheck;
import com.pulumi.gcp.compute.RegionHealthCheckArgs;
import com.pulumi.gcp.compute.inputs.RegionHealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
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) {
var healthCheck = new RegionHealthCheck("healthCheck", RegionHealthCheckArgs.builder()
.name("rbs-health-check")
.region("us-central1")
.httpHealthCheck(RegionHealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.region("us-central1")
.name("region-service")
.healthChecks(healthCheck.id())
.protocol("TCP")
.loadBalancingScheme("EXTERNAL")
.localityLbPolicy("WEIGHTED_MAGLEV")
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
region: us-central1
name: region-service
healthChecks: ${healthCheck.id}
protocol: TCP
loadBalancingScheme: EXTERNAL
localityLbPolicy: WEIGHTED_MAGLEV
healthCheck:
type: gcp:compute:RegionHealthCheck
name: health_check
properties:
name: rbs-health-check
region: us-central1
httpHealthCheck:
port: 80
Region Backend Service Ilb Ring Hash
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const healthCheck = new gcp.compute.HealthCheck("health_check", {
name: "rbs-health-check",
httpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
region: "us-central1",
name: "region-service",
healthChecks: healthCheck.id,
loadBalancingScheme: "INTERNAL_MANAGED",
localityLbPolicy: "RING_HASH",
sessionAffinity: "HTTP_COOKIE",
protocol: "HTTP",
circuitBreakers: {
maxConnections: 10,
},
consistentHash: {
httpCookie: {
ttl: {
seconds: 11,
nanos: 1111,
},
name: "mycookie",
},
},
outlierDetection: {
consecutiveErrors: 2,
},
});
import pulumi
import pulumi_gcp as gcp
health_check = gcp.compute.HealthCheck("health_check",
name="rbs-health-check",
http_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
region="us-central1",
name="region-service",
health_checks=health_check.id,
load_balancing_scheme="INTERNAL_MANAGED",
locality_lb_policy="RING_HASH",
session_affinity="HTTP_COOKIE",
protocol="HTTP",
circuit_breakers={
"max_connections": 10,
},
consistent_hash={
"http_cookie": {
"ttl": {
"seconds": 11,
"nanos": 1111,
},
"name": "mycookie",
},
},
outlier_detection={
"consecutive_errors": 2,
})
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 {
healthCheck, err := compute.NewHealthCheck(ctx, "health_check", &compute.HealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
HttpHealthCheck: &compute.HealthCheckHttpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("region-service"),
HealthChecks: healthCheck.ID(),
LoadBalancingScheme: pulumi.String("INTERNAL_MANAGED"),
LocalityLbPolicy: pulumi.String("RING_HASH"),
SessionAffinity: pulumi.String("HTTP_COOKIE"),
Protocol: pulumi.String("HTTP"),
CircuitBreakers: &compute.RegionBackendServiceCircuitBreakersArgs{
MaxConnections: pulumi.Int(10),
},
ConsistentHash: &compute.RegionBackendServiceConsistentHashArgs{
HttpCookie: &compute.RegionBackendServiceConsistentHashHttpCookieArgs{
Ttl: &compute.RegionBackendServiceConsistentHashHttpCookieTtlArgs{
Seconds: pulumi.Int(11),
Nanos: pulumi.Int(1111),
},
Name: pulumi.String("mycookie"),
},
},
OutlierDetection: &compute.RegionBackendServiceOutlierDetectionArgs{
ConsecutiveErrors: pulumi.Int(2),
},
})
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 healthCheck = new Gcp.Compute.HealthCheck("health_check", new()
{
Name = "rbs-health-check",
HttpHealthCheck = new Gcp.Compute.Inputs.HealthCheckHttpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Region = "us-central1",
Name = "region-service",
HealthChecks = healthCheck.Id,
LoadBalancingScheme = "INTERNAL_MANAGED",
LocalityLbPolicy = "RING_HASH",
SessionAffinity = "HTTP_COOKIE",
Protocol = "HTTP",
CircuitBreakers = new Gcp.Compute.Inputs.RegionBackendServiceCircuitBreakersArgs
{
MaxConnections = 10,
},
ConsistentHash = new Gcp.Compute.Inputs.RegionBackendServiceConsistentHashArgs
{
HttpCookie = new Gcp.Compute.Inputs.RegionBackendServiceConsistentHashHttpCookieArgs
{
Ttl = new Gcp.Compute.Inputs.RegionBackendServiceConsistentHashHttpCookieTtlArgs
{
Seconds = 11,
Nanos = 1111,
},
Name = "mycookie",
},
},
OutlierDetection = new Gcp.Compute.Inputs.RegionBackendServiceOutlierDetectionArgs
{
ConsecutiveErrors = 2,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceCircuitBreakersArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceConsistentHashArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceConsistentHashHttpCookieArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceConsistentHashHttpCookieTtlArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceOutlierDetectionArgs;
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) {
var healthCheck = new HealthCheck("healthCheck", HealthCheckArgs.builder()
.name("rbs-health-check")
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.region("us-central1")
.name("region-service")
.healthChecks(healthCheck.id())
.loadBalancingScheme("INTERNAL_MANAGED")
.localityLbPolicy("RING_HASH")
.sessionAffinity("HTTP_COOKIE")
.protocol("HTTP")
.circuitBreakers(RegionBackendServiceCircuitBreakersArgs.builder()
.maxConnections(10)
.build())
.consistentHash(RegionBackendServiceConsistentHashArgs.builder()
.httpCookie(RegionBackendServiceConsistentHashHttpCookieArgs.builder()
.ttl(RegionBackendServiceConsistentHashHttpCookieTtlArgs.builder()
.seconds(11)
.nanos(1111)
.build())
.name("mycookie")
.build())
.build())
.outlierDetection(RegionBackendServiceOutlierDetectionArgs.builder()
.consecutiveErrors(2)
.build())
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
region: us-central1
name: region-service
healthChecks: ${healthCheck.id}
loadBalancingScheme: INTERNAL_MANAGED
localityLbPolicy: RING_HASH
sessionAffinity: HTTP_COOKIE
protocol: HTTP
circuitBreakers:
maxConnections: 10
consistentHash:
httpCookie:
ttl:
seconds: 11
nanos: 1111
name: mycookie
outlierDetection:
consecutiveErrors: 2
healthCheck:
type: gcp:compute:HealthCheck
name: health_check
properties:
name: rbs-health-check
httpHealthCheck:
port: 80
Region Backend Service Ilb Stateful Session Affinity
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const healthCheck = new gcp.compute.HealthCheck("health_check", {
name: "rbs-health-check",
httpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
region: "us-central1",
name: "region-service",
healthChecks: healthCheck.id,
loadBalancingScheme: "INTERNAL_MANAGED",
localityLbPolicy: "RING_HASH",
sessionAffinity: "STRONG_COOKIE_AFFINITY",
protocol: "HTTP",
strongSessionAffinityCookie: {
ttl: {
seconds: 11,
nanos: 1111,
},
name: "mycookie",
},
});
import pulumi
import pulumi_gcp as gcp
health_check = gcp.compute.HealthCheck("health_check",
name="rbs-health-check",
http_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
region="us-central1",
name="region-service",
health_checks=health_check.id,
load_balancing_scheme="INTERNAL_MANAGED",
locality_lb_policy="RING_HASH",
session_affinity="STRONG_COOKIE_AFFINITY",
protocol="HTTP",
strong_session_affinity_cookie={
"ttl": {
"seconds": 11,
"nanos": 1111,
},
"name": "mycookie",
})
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 {
healthCheck, err := compute.NewHealthCheck(ctx, "health_check", &compute.HealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
HttpHealthCheck: &compute.HealthCheckHttpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("region-service"),
HealthChecks: healthCheck.ID(),
LoadBalancingScheme: pulumi.String("INTERNAL_MANAGED"),
LocalityLbPolicy: pulumi.String("RING_HASH"),
SessionAffinity: pulumi.String("STRONG_COOKIE_AFFINITY"),
Protocol: pulumi.String("HTTP"),
StrongSessionAffinityCookie: &compute.RegionBackendServiceStrongSessionAffinityCookieArgs{
Ttl: &compute.RegionBackendServiceStrongSessionAffinityCookieTtlArgs{
Seconds: pulumi.Int(11),
Nanos: pulumi.Int(1111),
},
Name: pulumi.String("mycookie"),
},
})
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 healthCheck = new Gcp.Compute.HealthCheck("health_check", new()
{
Name = "rbs-health-check",
HttpHealthCheck = new Gcp.Compute.Inputs.HealthCheckHttpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Region = "us-central1",
Name = "region-service",
HealthChecks = healthCheck.Id,
LoadBalancingScheme = "INTERNAL_MANAGED",
LocalityLbPolicy = "RING_HASH",
SessionAffinity = "STRONG_COOKIE_AFFINITY",
Protocol = "HTTP",
StrongSessionAffinityCookie = new Gcp.Compute.Inputs.RegionBackendServiceStrongSessionAffinityCookieArgs
{
Ttl = new Gcp.Compute.Inputs.RegionBackendServiceStrongSessionAffinityCookieTtlArgs
{
Seconds = 11,
Nanos = 1111,
},
Name = "mycookie",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceStrongSessionAffinityCookieArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceStrongSessionAffinityCookieTtlArgs;
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) {
var healthCheck = new HealthCheck("healthCheck", HealthCheckArgs.builder()
.name("rbs-health-check")
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.region("us-central1")
.name("region-service")
.healthChecks(healthCheck.id())
.loadBalancingScheme("INTERNAL_MANAGED")
.localityLbPolicy("RING_HASH")
.sessionAffinity("STRONG_COOKIE_AFFINITY")
.protocol("HTTP")
.strongSessionAffinityCookie(RegionBackendServiceStrongSessionAffinityCookieArgs.builder()
.ttl(RegionBackendServiceStrongSessionAffinityCookieTtlArgs.builder()
.seconds(11)
.nanos(1111)
.build())
.name("mycookie")
.build())
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
region: us-central1
name: region-service
healthChecks: ${healthCheck.id}
loadBalancingScheme: INTERNAL_MANAGED
localityLbPolicy: RING_HASH
sessionAffinity: STRONG_COOKIE_AFFINITY
protocol: HTTP
strongSessionAffinityCookie:
ttl:
seconds: 11
nanos: 1111
name: mycookie
healthCheck:
type: gcp:compute:HealthCheck
name: health_check
properties:
name: rbs-health-check
httpHealthCheck:
port: 80
Region Backend Service Balancing Mode
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const debianImage = gcp.compute.getImage({
family: "debian-11",
project: "debian-cloud",
});
const defaultNetwork = new gcp.compute.Network("default", {
name: "rbs-net",
autoCreateSubnetworks: false,
routingMode: "REGIONAL",
});
const defaultSubnetwork = new gcp.compute.Subnetwork("default", {
name: "rbs-net-default",
ipCidrRange: "10.1.2.0/24",
region: "us-central1",
network: defaultNetwork.id,
});
const instanceTemplate = new gcp.compute.InstanceTemplate("instance_template", {
name: "template-region-service",
machineType: "e2-medium",
networkInterfaces: [{
network: defaultNetwork.id,
subnetwork: defaultSubnetwork.id,
}],
disks: [{
sourceImage: debianImage.then(debianImage => debianImage.selfLink),
autoDelete: true,
boot: true,
}],
tags: [
"allow-ssh",
"load-balanced-backend",
],
});
const rigm = new gcp.compute.RegionInstanceGroupManager("rigm", {
region: "us-central1",
name: "rbs-rigm",
versions: [{
instanceTemplate: instanceTemplate.id,
name: "primary",
}],
baseInstanceName: "internal-glb",
targetSize: 1,
});
const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
region: "us-central1",
name: "rbs-health-check",
httpHealthCheck: {
portSpecification: "USE_SERVING_PORT",
},
});
const _default = new gcp.compute.RegionBackendService("default", {
loadBalancingScheme: "INTERNAL_MANAGED",
backends: [{
group: rigm.instanceGroup,
balancingMode: "UTILIZATION",
capacityScaler: 1,
}],
region: "us-central1",
name: "region-service",
protocol: "HTTP",
timeoutSec: 10,
healthChecks: defaultRegionHealthCheck.id,
});
import pulumi
import pulumi_gcp as gcp
debian_image = gcp.compute.get_image(family="debian-11",
project="debian-cloud")
default_network = gcp.compute.Network("default",
name="rbs-net",
auto_create_subnetworks=False,
routing_mode="REGIONAL")
default_subnetwork = gcp.compute.Subnetwork("default",
name="rbs-net-default",
ip_cidr_range="10.1.2.0/24",
region="us-central1",
network=default_network.id)
instance_template = gcp.compute.InstanceTemplate("instance_template",
name="template-region-service",
machine_type="e2-medium",
network_interfaces=[{
"network": default_network.id,
"subnetwork": default_subnetwork.id,
}],
disks=[{
"source_image": debian_image.self_link,
"auto_delete": True,
"boot": True,
}],
tags=[
"allow-ssh",
"load-balanced-backend",
])
rigm = gcp.compute.RegionInstanceGroupManager("rigm",
region="us-central1",
name="rbs-rigm",
versions=[{
"instance_template": instance_template.id,
"name": "primary",
}],
base_instance_name="internal-glb",
target_size=1)
default_region_health_check = gcp.compute.RegionHealthCheck("default",
region="us-central1",
name="rbs-health-check",
http_health_check={
"port_specification": "USE_SERVING_PORT",
})
default = gcp.compute.RegionBackendService("default",
load_balancing_scheme="INTERNAL_MANAGED",
backends=[{
"group": rigm.instance_group,
"balancing_mode": "UTILIZATION",
"capacity_scaler": 1,
}],
region="us-central1",
name="region-service",
protocol="HTTP",
timeout_sec=10,
health_checks=default_region_health_check.id)
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 {
debianImage, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
Family: pulumi.StringRef("debian-11"),
Project: pulumi.StringRef("debian-cloud"),
}, nil)
if err != nil {
return err
}
defaultNetwork, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
Name: pulumi.String("rbs-net"),
AutoCreateSubnetworks: pulumi.Bool(false),
RoutingMode: pulumi.String("REGIONAL"),
})
if err != nil {
return err
}
defaultSubnetwork, err := compute.NewSubnetwork(ctx, "default", &compute.SubnetworkArgs{
Name: pulumi.String("rbs-net-default"),
IpCidrRange: pulumi.String("10.1.2.0/24"),
Region: pulumi.String("us-central1"),
Network: defaultNetwork.ID(),
})
if err != nil {
return err
}
instanceTemplate, err := compute.NewInstanceTemplate(ctx, "instance_template", &compute.InstanceTemplateArgs{
Name: pulumi.String("template-region-service"),
MachineType: pulumi.String("e2-medium"),
NetworkInterfaces: compute.InstanceTemplateNetworkInterfaceArray{
&compute.InstanceTemplateNetworkInterfaceArgs{
Network: defaultNetwork.ID(),
Subnetwork: defaultSubnetwork.ID(),
},
},
Disks: compute.InstanceTemplateDiskArray{
&compute.InstanceTemplateDiskArgs{
SourceImage: pulumi.String(debianImage.SelfLink),
AutoDelete: pulumi.Bool(true),
Boot: pulumi.Bool(true),
},
},
Tags: pulumi.StringArray{
pulumi.String("allow-ssh"),
pulumi.String("load-balanced-backend"),
},
})
if err != nil {
return err
}
rigm, err := compute.NewRegionInstanceGroupManager(ctx, "rigm", &compute.RegionInstanceGroupManagerArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("rbs-rigm"),
Versions: compute.RegionInstanceGroupManagerVersionArray{
&compute.RegionInstanceGroupManagerVersionArgs{
InstanceTemplate: instanceTemplate.ID(),
Name: pulumi.String("primary"),
},
},
BaseInstanceName: pulumi.String("internal-glb"),
TargetSize: pulumi.Int(1),
})
if err != nil {
return err
}
defaultRegionHealthCheck, err := compute.NewRegionHealthCheck(ctx, "default", &compute.RegionHealthCheckArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("rbs-health-check"),
HttpHealthCheck: &compute.RegionHealthCheckHttpHealthCheckArgs{
PortSpecification: pulumi.String("USE_SERVING_PORT"),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
LoadBalancingScheme: pulumi.String("INTERNAL_MANAGED"),
Backends: compute.RegionBackendServiceBackendArray{
&compute.RegionBackendServiceBackendArgs{
Group: rigm.InstanceGroup,
BalancingMode: pulumi.String("UTILIZATION"),
CapacityScaler: pulumi.Float64(1),
},
},
Region: pulumi.String("us-central1"),
Name: pulumi.String("region-service"),
Protocol: pulumi.String("HTTP"),
TimeoutSec: pulumi.Int(10),
HealthChecks: defaultRegionHealthCheck.ID(),
})
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 debianImage = Gcp.Compute.GetImage.Invoke(new()
{
Family = "debian-11",
Project = "debian-cloud",
});
var defaultNetwork = new Gcp.Compute.Network("default", new()
{
Name = "rbs-net",
AutoCreateSubnetworks = false,
RoutingMode = "REGIONAL",
});
var defaultSubnetwork = new Gcp.Compute.Subnetwork("default", new()
{
Name = "rbs-net-default",
IpCidrRange = "10.1.2.0/24",
Region = "us-central1",
Network = defaultNetwork.Id,
});
var instanceTemplate = new Gcp.Compute.InstanceTemplate("instance_template", new()
{
Name = "template-region-service",
MachineType = "e2-medium",
NetworkInterfaces = new[]
{
new Gcp.Compute.Inputs.InstanceTemplateNetworkInterfaceArgs
{
Network = defaultNetwork.Id,
Subnetwork = defaultSubnetwork.Id,
},
},
Disks = new[]
{
new Gcp.Compute.Inputs.InstanceTemplateDiskArgs
{
SourceImage = debianImage.Apply(getImageResult => getImageResult.SelfLink),
AutoDelete = true,
Boot = true,
},
},
Tags = new[]
{
"allow-ssh",
"load-balanced-backend",
},
});
var rigm = new Gcp.Compute.RegionInstanceGroupManager("rigm", new()
{
Region = "us-central1",
Name = "rbs-rigm",
Versions = new[]
{
new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
{
InstanceTemplate = instanceTemplate.Id,
Name = "primary",
},
},
BaseInstanceName = "internal-glb",
TargetSize = 1,
});
var defaultRegionHealthCheck = new Gcp.Compute.RegionHealthCheck("default", new()
{
Region = "us-central1",
Name = "rbs-health-check",
HttpHealthCheck = new Gcp.Compute.Inputs.RegionHealthCheckHttpHealthCheckArgs
{
PortSpecification = "USE_SERVING_PORT",
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
LoadBalancingScheme = "INTERNAL_MANAGED",
Backends = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceBackendArgs
{
Group = rigm.InstanceGroup,
BalancingMode = "UTILIZATION",
CapacityScaler = 1,
},
},
Region = "us-central1",
Name = "region-service",
Protocol = "HTTP",
TimeoutSec = 10,
HealthChecks = defaultRegionHealthCheck.Id,
});
});
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.GetImageArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.compute.InstanceTemplate;
import com.pulumi.gcp.compute.InstanceTemplateArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateNetworkInterfaceArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateDiskArgs;
import com.pulumi.gcp.compute.RegionInstanceGroupManager;
import com.pulumi.gcp.compute.RegionInstanceGroupManagerArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerVersionArgs;
import com.pulumi.gcp.compute.RegionHealthCheck;
import com.pulumi.gcp.compute.RegionHealthCheckArgs;
import com.pulumi.gcp.compute.inputs.RegionHealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceBackendArgs;
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 debianImage = ComputeFunctions.getImage(GetImageArgs.builder()
.family("debian-11")
.project("debian-cloud")
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.name("rbs-net")
.autoCreateSubnetworks(false)
.routingMode("REGIONAL")
.build());
var defaultSubnetwork = new Subnetwork("defaultSubnetwork", SubnetworkArgs.builder()
.name("rbs-net-default")
.ipCidrRange("10.1.2.0/24")
.region("us-central1")
.network(defaultNetwork.id())
.build());
var instanceTemplate = new InstanceTemplate("instanceTemplate", InstanceTemplateArgs.builder()
.name("template-region-service")
.machineType("e2-medium")
.networkInterfaces(InstanceTemplateNetworkInterfaceArgs.builder()
.network(defaultNetwork.id())
.subnetwork(defaultSubnetwork.id())
.build())
.disks(InstanceTemplateDiskArgs.builder()
.sourceImage(debianImage.selfLink())
.autoDelete(true)
.boot(true)
.build())
.tags(
"allow-ssh",
"load-balanced-backend")
.build());
var rigm = new RegionInstanceGroupManager("rigm", RegionInstanceGroupManagerArgs.builder()
.region("us-central1")
.name("rbs-rigm")
.versions(RegionInstanceGroupManagerVersionArgs.builder()
.instanceTemplate(instanceTemplate.id())
.name("primary")
.build())
.baseInstanceName("internal-glb")
.targetSize(1)
.build());
var defaultRegionHealthCheck = new RegionHealthCheck("defaultRegionHealthCheck", RegionHealthCheckArgs.builder()
.region("us-central1")
.name("rbs-health-check")
.httpHealthCheck(RegionHealthCheckHttpHealthCheckArgs.builder()
.portSpecification("USE_SERVING_PORT")
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.loadBalancingScheme("INTERNAL_MANAGED")
.backends(RegionBackendServiceBackendArgs.builder()
.group(rigm.instanceGroup())
.balancingMode("UTILIZATION")
.capacityScaler(1.0)
.build())
.region("us-central1")
.name("region-service")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(defaultRegionHealthCheck.id())
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
loadBalancingScheme: INTERNAL_MANAGED
backends:
- group: ${rigm.instanceGroup}
balancingMode: UTILIZATION
capacityScaler: 1
region: us-central1
name: region-service
protocol: HTTP
timeoutSec: 10
healthChecks: ${defaultRegionHealthCheck.id}
rigm:
type: gcp:compute:RegionInstanceGroupManager
properties:
region: us-central1
name: rbs-rigm
versions:
- instanceTemplate: ${instanceTemplate.id}
name: primary
baseInstanceName: internal-glb
targetSize: 1
instanceTemplate:
type: gcp:compute:InstanceTemplate
name: instance_template
properties:
name: template-region-service
machineType: e2-medium
networkInterfaces:
- network: ${defaultNetwork.id}
subnetwork: ${defaultSubnetwork.id}
disks:
- sourceImage: ${debianImage.selfLink}
autoDelete: true
boot: true
tags:
- allow-ssh
- load-balanced-backend
defaultRegionHealthCheck:
type: gcp:compute:RegionHealthCheck
name: default
properties:
region: us-central1
name: rbs-health-check
httpHealthCheck:
portSpecification: USE_SERVING_PORT
defaultNetwork:
type: gcp:compute:Network
name: default
properties:
name: rbs-net
autoCreateSubnetworks: false
routingMode: REGIONAL
defaultSubnetwork:
type: gcp:compute:Subnetwork
name: default
properties:
name: rbs-net-default
ipCidrRange: 10.1.2.0/24
region: us-central1
network: ${defaultNetwork.id}
variables:
debianImage:
fn::invoke:
function: gcp:compute:getImage
arguments:
family: debian-11
project: debian-cloud
Region Backend Service Connection Tracking
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
name: "rbs-health-check",
region: "us-central1",
tcpHealthCheck: {
port: 22,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
name: "region-service",
region: "us-central1",
healthChecks: healthCheck.id,
connectionDrainingTimeoutSec: 10,
sessionAffinity: "CLIENT_IP",
protocol: "TCP",
loadBalancingScheme: "EXTERNAL",
connectionTrackingPolicy: {
trackingMode: "PER_SESSION",
connectionPersistenceOnUnhealthyBackends: "NEVER_PERSIST",
idleTimeoutSec: 60,
enableStrongAffinity: true,
},
});
import pulumi
import pulumi_gcp as gcp
health_check = gcp.compute.RegionHealthCheck("health_check",
name="rbs-health-check",
region="us-central1",
tcp_health_check={
"port": 22,
})
default = gcp.compute.RegionBackendService("default",
name="region-service",
region="us-central1",
health_checks=health_check.id,
connection_draining_timeout_sec=10,
session_affinity="CLIENT_IP",
protocol="TCP",
load_balancing_scheme="EXTERNAL",
connection_tracking_policy={
"tracking_mode": "PER_SESSION",
"connection_persistence_on_unhealthy_backends": "NEVER_PERSIST",
"idle_timeout_sec": 60,
"enable_strong_affinity": True,
})
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 {
healthCheck, err := compute.NewRegionHealthCheck(ctx, "health_check", &compute.RegionHealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
Region: pulumi.String("us-central1"),
TcpHealthCheck: &compute.RegionHealthCheckTcpHealthCheckArgs{
Port: pulumi.Int(22),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Name: pulumi.String("region-service"),
Region: pulumi.String("us-central1"),
HealthChecks: healthCheck.ID(),
ConnectionDrainingTimeoutSec: pulumi.Int(10),
SessionAffinity: pulumi.String("CLIENT_IP"),
Protocol: pulumi.String("TCP"),
LoadBalancingScheme: pulumi.String("EXTERNAL"),
ConnectionTrackingPolicy: &compute.RegionBackendServiceConnectionTrackingPolicyArgs{
TrackingMode: pulumi.String("PER_SESSION"),
ConnectionPersistenceOnUnhealthyBackends: pulumi.String("NEVER_PERSIST"),
IdleTimeoutSec: pulumi.Int(60),
EnableStrongAffinity: pulumi.Bool(true),
},
})
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 healthCheck = new Gcp.Compute.RegionHealthCheck("health_check", new()
{
Name = "rbs-health-check",
Region = "us-central1",
TcpHealthCheck = new Gcp.Compute.Inputs.RegionHealthCheckTcpHealthCheckArgs
{
Port = 22,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Name = "region-service",
Region = "us-central1",
HealthChecks = healthCheck.Id,
ConnectionDrainingTimeoutSec = 10,
SessionAffinity = "CLIENT_IP",
Protocol = "TCP",
LoadBalancingScheme = "EXTERNAL",
ConnectionTrackingPolicy = new Gcp.Compute.Inputs.RegionBackendServiceConnectionTrackingPolicyArgs
{
TrackingMode = "PER_SESSION",
ConnectionPersistenceOnUnhealthyBackends = "NEVER_PERSIST",
IdleTimeoutSec = 60,
EnableStrongAffinity = true,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionHealthCheck;
import com.pulumi.gcp.compute.RegionHealthCheckArgs;
import com.pulumi.gcp.compute.inputs.RegionHealthCheckTcpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceConnectionTrackingPolicyArgs;
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) {
var healthCheck = new RegionHealthCheck("healthCheck", RegionHealthCheckArgs.builder()
.name("rbs-health-check")
.region("us-central1")
.tcpHealthCheck(RegionHealthCheckTcpHealthCheckArgs.builder()
.port(22)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.name("region-service")
.region("us-central1")
.healthChecks(healthCheck.id())
.connectionDrainingTimeoutSec(10)
.sessionAffinity("CLIENT_IP")
.protocol("TCP")
.loadBalancingScheme("EXTERNAL")
.connectionTrackingPolicy(RegionBackendServiceConnectionTrackingPolicyArgs.builder()
.trackingMode("PER_SESSION")
.connectionPersistenceOnUnhealthyBackends("NEVER_PERSIST")
.idleTimeoutSec(60)
.enableStrongAffinity(true)
.build())
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
name: region-service
region: us-central1
healthChecks: ${healthCheck.id}
connectionDrainingTimeoutSec: 10
sessionAffinity: CLIENT_IP
protocol: TCP
loadBalancingScheme: EXTERNAL
connectionTrackingPolicy:
trackingMode: PER_SESSION
connectionPersistenceOnUnhealthyBackends: NEVER_PERSIST
idleTimeoutSec: 60
enableStrongAffinity: true
healthCheck:
type: gcp:compute:RegionHealthCheck
name: health_check
properties:
name: rbs-health-check
region: us-central1
tcpHealthCheck:
port: 22
Region Backend Service Ip Address Selection Policy
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
name: "rbs-health-check",
region: "us-central1",
tcpHealthCheck: {
port: 80,
},
});
const _default = new gcp.compute.RegionBackendService("default", {
name: "region-service",
region: "us-central1",
healthChecks: healthCheck.id,
loadBalancingScheme: "EXTERNAL_MANAGED",
protocol: "HTTP",
ipAddressSelectionPolicy: "IPV6_ONLY",
});
import pulumi
import pulumi_gcp as gcp
health_check = gcp.compute.RegionHealthCheck("health_check",
name="rbs-health-check",
region="us-central1",
tcp_health_check={
"port": 80,
})
default = gcp.compute.RegionBackendService("default",
name="region-service",
region="us-central1",
health_checks=health_check.id,
load_balancing_scheme="EXTERNAL_MANAGED",
protocol="HTTP",
ip_address_selection_policy="IPV6_ONLY")
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 {
healthCheck, err := compute.NewRegionHealthCheck(ctx, "health_check", &compute.RegionHealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
Region: pulumi.String("us-central1"),
TcpHealthCheck: &compute.RegionHealthCheckTcpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Name: pulumi.String("region-service"),
Region: pulumi.String("us-central1"),
HealthChecks: healthCheck.ID(),
LoadBalancingScheme: pulumi.String("EXTERNAL_MANAGED"),
Protocol: pulumi.String("HTTP"),
IpAddressSelectionPolicy: pulumi.String("IPV6_ONLY"),
})
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 healthCheck = new Gcp.Compute.RegionHealthCheck("health_check", new()
{
Name = "rbs-health-check",
Region = "us-central1",
TcpHealthCheck = new Gcp.Compute.Inputs.RegionHealthCheckTcpHealthCheckArgs
{
Port = 80,
},
});
var @default = new Gcp.Compute.RegionBackendService("default", new()
{
Name = "region-service",
Region = "us-central1",
HealthChecks = healthCheck.Id,
LoadBalancingScheme = "EXTERNAL_MANAGED",
Protocol = "HTTP",
IpAddressSelectionPolicy = "IPV6_ONLY",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionHealthCheck;
import com.pulumi.gcp.compute.RegionHealthCheckArgs;
import com.pulumi.gcp.compute.inputs.RegionHealthCheckTcpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
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) {
var healthCheck = new RegionHealthCheck("healthCheck", RegionHealthCheckArgs.builder()
.name("rbs-health-check")
.region("us-central1")
.tcpHealthCheck(RegionHealthCheckTcpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()
.name("region-service")
.region("us-central1")
.healthChecks(healthCheck.id())
.loadBalancingScheme("EXTERNAL_MANAGED")
.protocol("HTTP")
.ipAddressSelectionPolicy("IPV6_ONLY")
.build());
}
}
resources:
default:
type: gcp:compute:RegionBackendService
properties:
name: region-service
region: us-central1
healthChecks: ${healthCheck.id}
loadBalancingScheme: EXTERNAL_MANAGED
protocol: HTTP
ipAddressSelectionPolicy: IPV6_ONLY
healthCheck:
type: gcp:compute:RegionHealthCheck
name: health_check
properties:
name: rbs-health-check
region: us-central1
tcpHealthCheck:
port: 80
Region Backend Service Ilb Custom Metrics
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.compute.Network("default", {name: "network"});
// Zonal NEG with GCE_VM_IP_PORT
const defaultNetworkEndpointGroup = new gcp.compute.NetworkEndpointGroup("default", {
name: "network-endpoint",
network: _default.id,
defaultPort: 90,
zone: "us-central1-a",
networkEndpointType: "GCE_VM_IP_PORT",
});
const healthCheck = new gcp.compute.HealthCheck("health_check", {
name: "rbs-health-check",
httpHealthCheck: {
port: 80,
},
});
const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
region: "us-central1",
name: "region-service",
healthChecks: healthCheck.id,
loadBalancingScheme: "INTERNAL_MANAGED",
localityLbPolicy: "WEIGHTED_ROUND_ROBIN",
customMetrics: [{
name: "orca.application_utilization",
dryRun: false,
}],
backends: [{
group: defaultNetworkEndpointGroup.id,
balancingMode: "CUSTOM_METRICS",
customMetrics: [
{
name: "orca.cpu_utilization",
maxUtilization: 0.9,
dryRun: true,
},
{
name: "orca.named_metrics.foo",
dryRun: false,
},
],
}],
});
import pulumi
import pulumi_gcp as gcp
default = gcp.compute.Network("default", name="network")
# Zonal NEG with GCE_VM_IP_PORT
default_network_endpoint_group = gcp.compute.NetworkEndpointGroup("default",
name="network-endpoint",
network=default.id,
default_port=90,
zone="us-central1-a",
network_endpoint_type="GCE_VM_IP_PORT")
health_check = gcp.compute.HealthCheck("health_check",
name="rbs-health-check",
http_health_check={
"port": 80,
})
default_region_backend_service = gcp.compute.RegionBackendService("default",
region="us-central1",
name="region-service",
health_checks=health_check.id,
load_balancing_scheme="INTERNAL_MANAGED",
locality_lb_policy="WEIGHTED_ROUND_ROBIN",
custom_metrics=[{
"name": "orca.application_utilization",
"dry_run": False,
}],
backends=[{
"group": default_network_endpoint_group.id,
"balancing_mode": "CUSTOM_METRICS",
"custom_metrics": [
{
"name": "orca.cpu_utilization",
"max_utilization": 0.9,
"dry_run": True,
},
{
"name": "orca.named_metrics.foo",
"dry_run": False,
},
],
}])
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 {
_default, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
Name: pulumi.String("network"),
})
if err != nil {
return err
}
// Zonal NEG with GCE_VM_IP_PORT
defaultNetworkEndpointGroup, err := compute.NewNetworkEndpointGroup(ctx, "default", &compute.NetworkEndpointGroupArgs{
Name: pulumi.String("network-endpoint"),
Network: _default.ID(),
DefaultPort: pulumi.Int(90),
Zone: pulumi.String("us-central1-a"),
NetworkEndpointType: pulumi.String("GCE_VM_IP_PORT"),
})
if err != nil {
return err
}
healthCheck, err := compute.NewHealthCheck(ctx, "health_check", &compute.HealthCheckArgs{
Name: pulumi.String("rbs-health-check"),
HttpHealthCheck: &compute.HealthCheckHttpHealthCheckArgs{
Port: pulumi.Int(80),
},
})
if err != nil {
return err
}
_, err = compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
Region: pulumi.String("us-central1"),
Name: pulumi.String("region-service"),
HealthChecks: healthCheck.ID(),
LoadBalancingScheme: pulumi.String("INTERNAL_MANAGED"),
LocalityLbPolicy: pulumi.String("WEIGHTED_ROUND_ROBIN"),
CustomMetrics: compute.RegionBackendServiceCustomMetricArray{
&compute.RegionBackendServiceCustomMetricArgs{
Name: pulumi.String("orca.application_utilization"),
DryRun: pulumi.Bool(false),
},
},
Backends: compute.RegionBackendServiceBackendArray{
&compute.RegionBackendServiceBackendArgs{
Group: defaultNetworkEndpointGroup.ID(),
BalancingMode: pulumi.String("CUSTOM_METRICS"),
CustomMetrics: compute.RegionBackendServiceBackendCustomMetricArray{
&compute.RegionBackendServiceBackendCustomMetricArgs{
Name: pulumi.String("orca.cpu_utilization"),
MaxUtilization: pulumi.Float64(0.9),
DryRun: pulumi.Bool(true),
},
&compute.RegionBackendServiceBackendCustomMetricArgs{
Name: pulumi.String("orca.named_metrics.foo"),
DryRun: pulumi.Bool(false),
},
},
},
},
})
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 @default = new Gcp.Compute.Network("default", new()
{
Name = "network",
});
// Zonal NEG with GCE_VM_IP_PORT
var defaultNetworkEndpointGroup = new Gcp.Compute.NetworkEndpointGroup("default", new()
{
Name = "network-endpoint",
Network = @default.Id,
DefaultPort = 90,
Zone = "us-central1-a",
NetworkEndpointType = "GCE_VM_IP_PORT",
});
var healthCheck = new Gcp.Compute.HealthCheck("health_check", new()
{
Name = "rbs-health-check",
HttpHealthCheck = new Gcp.Compute.Inputs.HealthCheckHttpHealthCheckArgs
{
Port = 80,
},
});
var defaultRegionBackendService = new Gcp.Compute.RegionBackendService("default", new()
{
Region = "us-central1",
Name = "region-service",
HealthChecks = healthCheck.Id,
LoadBalancingScheme = "INTERNAL_MANAGED",
LocalityLbPolicy = "WEIGHTED_ROUND_ROBIN",
CustomMetrics = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceCustomMetricArgs
{
Name = "orca.application_utilization",
DryRun = false,
},
},
Backends = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceBackendArgs
{
Group = defaultNetworkEndpointGroup.Id,
BalancingMode = "CUSTOM_METRICS",
CustomMetrics = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceBackendCustomMetricArgs
{
Name = "orca.cpu_utilization",
MaxUtilization = 0.9,
DryRun = true,
},
new Gcp.Compute.Inputs.RegionBackendServiceBackendCustomMetricArgs
{
Name = "orca.named_metrics.foo",
DryRun = false,
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.NetworkEndpointGroup;
import com.pulumi.gcp.compute.NetworkEndpointGroupArgs;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceCustomMetricArgs;
import com.pulumi.gcp.compute.inputs.RegionBackendServiceBackendArgs;
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) {
var default_ = new Network("default", NetworkArgs.builder()
.name("network")
.build());
// Zonal NEG with GCE_VM_IP_PORT
var defaultNetworkEndpointGroup = new NetworkEndpointGroup("defaultNetworkEndpointGroup", NetworkEndpointGroupArgs.builder()
.name("network-endpoint")
.network(default_.id())
.defaultPort(90)
.zone("us-central1-a")
.networkEndpointType("GCE_VM_IP_PORT")
.build());
var healthCheck = new HealthCheck("healthCheck", HealthCheckArgs.builder()
.name("rbs-health-check")
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var defaultRegionBackendService = new RegionBackendService("defaultRegionBackendService", RegionBackendServiceArgs.builder()
.region("us-central1")
.name("region-service")
.healthChecks(healthCheck.id())
.loadBalancingScheme("INTERNAL_MANAGED")
.localityLbPolicy("WEIGHTED_ROUND_ROBIN")
.customMetrics(RegionBackendServiceCustomMetricArgs.builder()
.name("orca.application_utilization")
.dryRun(false)
.build())
.backends(RegionBackendServiceBackendArgs.builder()
.group(defaultNetworkEndpointGroup.id())
.balancingMode("CUSTOM_METRICS")
.customMetrics(
RegionBackendServiceBackendCustomMetricArgs.builder()
.name("orca.cpu_utilization")
.maxUtilization(0.9)
.dryRun(true)
.build(),
RegionBackendServiceBackendCustomMetricArgs.builder()
.name("orca.named_metrics.foo")
.dryRun(false)
.build())
.build())
.build());
}
}
resources:
default:
type: gcp:compute:Network
properties:
name: network
# Zonal NEG with GCE_VM_IP_PORT
defaultNetworkEndpointGroup:
type: gcp:compute:NetworkEndpointGroup
name: default
properties:
name: network-endpoint
network: ${default.id}
defaultPort: '90'
zone: us-central1-a
networkEndpointType: GCE_VM_IP_PORT
defaultRegionBackendService:
type: gcp:compute:RegionBackendService
name: default
properties:
region: us-central1
name: region-service
healthChecks: ${healthCheck.id}
loadBalancingScheme: INTERNAL_MANAGED
localityLbPolicy: WEIGHTED_ROUND_ROBIN
customMetrics:
- name: orca.application_utilization
dryRun: false
backends:
- group: ${defaultNetworkEndpointGroup.id}
balancingMode: CUSTOM_METRICS
customMetrics:
- name: orca.cpu_utilization
maxUtilization: 0.9
dryRun: true
- name: orca.named_metrics.foo
dryRun: false
healthCheck:
type: gcp:compute:HealthCheck
name: health_check
properties:
name: rbs-health-check
httpHealthCheck:
port: 80
Create RegionBackendService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RegionBackendService(name: string, args?: RegionBackendServiceArgs, opts?: CustomResourceOptions);@overload
def RegionBackendService(resource_name: str,
args: Optional[RegionBackendServiceArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def RegionBackendService(resource_name: str,
opts: Optional[ResourceOptions] = None,
affinity_cookie_ttl_sec: Optional[int] = None,
backends: Optional[Sequence[RegionBackendServiceBackendArgs]] = None,
cdn_policy: Optional[RegionBackendServiceCdnPolicyArgs] = None,
circuit_breakers: Optional[RegionBackendServiceCircuitBreakersArgs] = None,
connection_draining_timeout_sec: Optional[int] = None,
connection_tracking_policy: Optional[RegionBackendServiceConnectionTrackingPolicyArgs] = None,
consistent_hash: Optional[RegionBackendServiceConsistentHashArgs] = None,
custom_metrics: Optional[Sequence[RegionBackendServiceCustomMetricArgs]] = None,
description: Optional[str] = None,
enable_cdn: Optional[bool] = None,
failover_policy: Optional[RegionBackendServiceFailoverPolicyArgs] = None,
health_checks: Optional[str] = None,
iap: Optional[RegionBackendServiceIapArgs] = None,
ip_address_selection_policy: Optional[str] = None,
load_balancing_scheme: Optional[str] = None,
locality_lb_policy: Optional[str] = None,
log_config: Optional[RegionBackendServiceLogConfigArgs] = None,
name: Optional[str] = None,
network: Optional[str] = None,
outlier_detection: Optional[RegionBackendServiceOutlierDetectionArgs] = None,
port_name: Optional[str] = None,
project: Optional[str] = None,
protocol: Optional[str] = None,
region: Optional[str] = None,
security_policy: Optional[str] = None,
session_affinity: Optional[str] = None,
strong_session_affinity_cookie: Optional[RegionBackendServiceStrongSessionAffinityCookieArgs] = None,
subsetting: Optional[RegionBackendServiceSubsettingArgs] = None,
timeout_sec: Optional[int] = None)func NewRegionBackendService(ctx *Context, name string, args *RegionBackendServiceArgs, opts ...ResourceOption) (*RegionBackendService, error)public RegionBackendService(string name, RegionBackendServiceArgs? args = null, CustomResourceOptions? opts = null)public RegionBackendService(String name, RegionBackendServiceArgs args)
public RegionBackendService(String name, RegionBackendServiceArgs args, CustomResourceOptions options)
type: gcp:compute:RegionBackendService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args RegionBackendServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args RegionBackendServiceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args RegionBackendServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args RegionBackendServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. RegionBackendServiceArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var regionBackendServiceResource = new Gcp.Compute.RegionBackendService("regionBackendServiceResource", new()
{
AffinityCookieTtlSec = 0,
Backends = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceBackendArgs
{
Group = "string",
MaxConnections = 0,
CustomMetrics = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceBackendCustomMetricArgs
{
DryRun = false,
Name = "string",
MaxUtilization = 0,
},
},
Description = "string",
Failover = false,
CapacityScaler = 0,
BalancingMode = "string",
MaxConnectionsPerEndpoint = 0,
MaxConnectionsPerInstance = 0,
MaxRate = 0,
MaxRatePerEndpoint = 0,
MaxRatePerInstance = 0,
MaxUtilization = 0,
},
},
CdnPolicy = new Gcp.Compute.Inputs.RegionBackendServiceCdnPolicyArgs
{
CacheKeyPolicy = new Gcp.Compute.Inputs.RegionBackendServiceCdnPolicyCacheKeyPolicyArgs
{
IncludeHost = false,
IncludeNamedCookies = new[]
{
"string",
},
IncludeProtocol = false,
IncludeQueryString = false,
QueryStringBlacklists = new[]
{
"string",
},
QueryStringWhitelists = new[]
{
"string",
},
},
CacheMode = "string",
ClientTtl = 0,
DefaultTtl = 0,
MaxTtl = 0,
NegativeCaching = false,
NegativeCachingPolicies = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceCdnPolicyNegativeCachingPolicyArgs
{
Code = 0,
Ttl = 0,
},
},
ServeWhileStale = 0,
SignedUrlCacheMaxAgeSec = 0,
},
CircuitBreakers = new Gcp.Compute.Inputs.RegionBackendServiceCircuitBreakersArgs
{
ConnectTimeout = new Gcp.Compute.Inputs.RegionBackendServiceCircuitBreakersConnectTimeoutArgs
{
Seconds = 0,
Nanos = 0,
},
MaxConnections = 0,
MaxPendingRequests = 0,
MaxRequests = 0,
MaxRequestsPerConnection = 0,
MaxRetries = 0,
},
ConnectionDrainingTimeoutSec = 0,
ConnectionTrackingPolicy = new Gcp.Compute.Inputs.RegionBackendServiceConnectionTrackingPolicyArgs
{
ConnectionPersistenceOnUnhealthyBackends = "string",
EnableStrongAffinity = false,
IdleTimeoutSec = 0,
TrackingMode = "string",
},
ConsistentHash = new Gcp.Compute.Inputs.RegionBackendServiceConsistentHashArgs
{
HttpCookie = new Gcp.Compute.Inputs.RegionBackendServiceConsistentHashHttpCookieArgs
{
Name = "string",
Path = "string",
Ttl = new Gcp.Compute.Inputs.RegionBackendServiceConsistentHashHttpCookieTtlArgs
{
Seconds = 0,
Nanos = 0,
},
},
HttpHeaderName = "string",
MinimumRingSize = 0,
},
CustomMetrics = new[]
{
new Gcp.Compute.Inputs.RegionBackendServiceCustomMetricArgs
{
DryRun = false,
Name = "string",
},
},
Description = "string",
EnableCdn = false,
FailoverPolicy = new Gcp.Compute.Inputs.RegionBackendServiceFailoverPolicyArgs
{
DisableConnectionDrainOnFailover = false,
DropTrafficIfUnhealthy = false,
FailoverRatio = 0,
},
HealthChecks = "string",
Iap = new Gcp.Compute.Inputs.RegionBackendServiceIapArgs
{
Enabled = false,
Oauth2ClientId = "string",
Oauth2ClientSecret = "string",
Oauth2ClientSecretSha256 = "string",
},
IpAddressSelectionPolicy = "string",
LoadBalancingScheme = "string",
LocalityLbPolicy = "string",
LogConfig = new Gcp.Compute.Inputs.RegionBackendServiceLogConfigArgs
{
Enable = false,
OptionalFields = new[]
{
"string",
},
OptionalMode = "string",
SampleRate = 0,
},
Name = "string",
Network = "string",
OutlierDetection = new Gcp.Compute.Inputs.RegionBackendServiceOutlierDetectionArgs
{
BaseEjectionTime = new Gcp.Compute.Inputs.RegionBackendServiceOutlierDetectionBaseEjectionTimeArgs
{
Seconds = 0,
Nanos = 0,
},
ConsecutiveErrors = 0,
ConsecutiveGatewayFailure = 0,
EnforcingConsecutiveErrors = 0,
EnforcingConsecutiveGatewayFailure = 0,
EnforcingSuccessRate = 0,
Interval = new Gcp.Compute.Inputs.RegionBackendServiceOutlierDetectionIntervalArgs
{
Seconds = 0,
Nanos = 0,
},
MaxEjectionPercent = 0,
SuccessRateMinimumHosts = 0,
SuccessRateRequestVolume = 0,
SuccessRateStdevFactor = 0,
},
PortName = "string",
Project = "string",
Protocol = "string",
Region = "string",
SecurityPolicy = "string",
SessionAffinity = "string",
StrongSessionAffinityCookie = new Gcp.Compute.Inputs.RegionBackendServiceStrongSessionAffinityCookieArgs
{
Name = "string",
Path = "string",
Ttl = new Gcp.Compute.Inputs.RegionBackendServiceStrongSessionAffinityCookieTtlArgs
{
Seconds = 0,
Nanos = 0,
},
},
Subsetting = new Gcp.Compute.Inputs.RegionBackendServiceSubsettingArgs
{
Policy = "string",
},
TimeoutSec = 0,
});
example, err := compute.NewRegionBackendService(ctx, "regionBackendServiceResource", &compute.RegionBackendServiceArgs{
AffinityCookieTtlSec: pulumi.Int(0),
Backends: compute.RegionBackendServiceBackendArray{
&compute.RegionBackendServiceBackendArgs{
Group: pulumi.String("string"),
MaxConnections: pulumi.Int(0),
CustomMetrics: compute.RegionBackendServiceBackendCustomMetricArray{
&compute.RegionBackendServiceBackendCustomMetricArgs{
DryRun: pulumi.Bool(false),
Name: pulumi.String("string"),
MaxUtilization: pulumi.Float64(0),
},
},
Description: pulumi.String("string"),
Failover: pulumi.Bool(false),
CapacityScaler: pulumi.Float64(0),
BalancingMode: pulumi.String("string"),
MaxConnectionsPerEndpoint: pulumi.Int(0),
MaxConnectionsPerInstance: pulumi.Int(0),
MaxRate: pulumi.Int(0),
MaxRatePerEndpoint: pulumi.Float64(0),
MaxRatePerInstance: pulumi.Float64(0),
MaxUtilization: pulumi.Float64(0),
},
},
CdnPolicy: &compute.RegionBackendServiceCdnPolicyArgs{
CacheKeyPolicy: &compute.RegionBackendServiceCdnPolicyCacheKeyPolicyArgs{
IncludeHost: pulumi.Bool(false),
IncludeNamedCookies: pulumi.StringArray{
pulumi.String("string"),
},
IncludeProtocol: pulumi.Bool(false),
IncludeQueryString: pulumi.Bool(false),
QueryStringBlacklists: pulumi.StringArray{
pulumi.String("string"),
},
QueryStringWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
},
CacheMode: pulumi.String("string"),
ClientTtl: pulumi.Int(0),
DefaultTtl: pulumi.Int(0),
MaxTtl: pulumi.Int(0),
NegativeCaching: pulumi.Bool(false),
NegativeCachingPolicies: compute.RegionBackendServiceCdnPolicyNegativeCachingPolicyArray{
&compute.RegionBackendServiceCdnPolicyNegativeCachingPolicyArgs{
Code: pulumi.Int(0),
Ttl: pulumi.Int(0),
},
},
ServeWhileStale: pulumi.Int(0),
SignedUrlCacheMaxAgeSec: pulumi.Int(0),
},
CircuitBreakers: &compute.RegionBackendServiceCircuitBreakersArgs{
ConnectTimeout: &compute.RegionBackendServiceCircuitBreakersConnectTimeoutArgs{
Seconds: pulumi.Int(0),
Nanos: pulumi.Int(0),
},
MaxConnections: pulumi.Int(0),
MaxPendingRequests: pulumi.Int(0),
MaxRequests: pulumi.Int(0),
MaxRequestsPerConnection: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
},
ConnectionDrainingTimeoutSec: pulumi.Int(0),
ConnectionTrackingPolicy: &compute.RegionBackendServiceConnectionTrackingPolicyArgs{
ConnectionPersistenceOnUnhealthyBackends: pulumi.String("string"),
EnableStrongAffinity: pulumi.Bool(false),
IdleTimeoutSec: pulumi.Int(0),
TrackingMode: pulumi.String("string"),
},
ConsistentHash: &compute.RegionBackendServiceConsistentHashArgs{
HttpCookie: &compute.RegionBackendServiceConsistentHashHttpCookieArgs{
Name: pulumi.String("string"),
Path: pulumi.String("string"),
Ttl: &compute.RegionBackendServiceConsistentHashHttpCookieTtlArgs{
Seconds: pulumi.Int(0),
Nanos: pulumi.Int(0),
},
},
HttpHeaderName: pulumi.String("string"),
MinimumRingSize: pulumi.Int(0),
},
CustomMetrics: compute.RegionBackendServiceCustomMetricArray{
&compute.RegionBackendServiceCustomMetricArgs{
DryRun: pulumi.Bool(false),
Name: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
EnableCdn: pulumi.Bool(false),
FailoverPolicy: &compute.RegionBackendServiceFailoverPolicyArgs{
DisableConnectionDrainOnFailover: pulumi.Bool(false),
DropTrafficIfUnhealthy: pulumi.Bool(false),
FailoverRatio: pulumi.Float64(0),
},
HealthChecks: pulumi.String("string"),
Iap: &compute.RegionBackendServiceIapArgs{
Enabled: pulumi.Bool(false),
Oauth2ClientId: pulumi.String("string"),
Oauth2ClientSecret: pulumi.String("string"),
Oauth2ClientSecretSha256: pulumi.String("string"),
},
IpAddressSelectionPolicy: pulumi.String("string"),
LoadBalancingScheme: pulumi.String("string"),
LocalityLbPolicy: pulumi.String("string"),
LogConfig: &compute.RegionBackendServiceLogConfigArgs{
Enable: pulumi.Bool(false),
OptionalFields: pulumi.StringArray{
pulumi.String("string"),
},
OptionalMode: pulumi.String("string"),
SampleRate: pulumi.Float64(0),
},
Name: pulumi.String("string"),
Network: pulumi.String("string"),
OutlierDetection: &compute.RegionBackendServiceOutlierDetectionArgs{
BaseEjectionTime: &compute.RegionBackendServiceOutlierDetectionBaseEjectionTimeArgs{
Seconds: pulumi.Int(0),
Nanos: pulumi.Int(0),
},
ConsecutiveErrors: pulumi.Int(0),
ConsecutiveGatewayFailure: pulumi.Int(0),
EnforcingConsecutiveErrors: pulumi.Int(0),
EnforcingConsecutiveGatewayFailure: pulumi.Int(0),
EnforcingSuccessRate: pulumi.Int(0),
Interval: &compute.RegionBackendServiceOutlierDetectionIntervalArgs{
Seconds: pulumi.Int(0),
Nanos: pulumi.Int(0),
},
MaxEjectionPercent: pulumi.Int(0),
SuccessRateMinimumHosts: pulumi.Int(0),
SuccessRateRequestVolume: pulumi.Int(0),
SuccessRateStdevFactor: pulumi.Int(0),
},
PortName: pulumi.String("string"),
Project: pulumi.String("string"),
Protocol: pulumi.String("string"),
Region: pulumi.String("string"),
SecurityPolicy: pulumi.String("string"),
SessionAffinity: pulumi.String("string"),
StrongSessionAffinityCookie: &compute.RegionBackendServiceStrongSessionAffinityCookieArgs{
Name: pulumi.String("string"),
Path: pulumi.String("string"),
Ttl: &compute.RegionBackendServiceStrongSessionAffinityCookieTtlArgs{
Seconds: pulumi.Int(0),
Nanos: pulumi.Int(0),
},
},
Subsetting: &compute.RegionBackendServiceSubsettingArgs{
Policy: pulumi.String("string"),
},
TimeoutSec: pulumi.Int(0),
})
var regionBackendServiceResource = new RegionBackendService("regionBackendServiceResource", RegionBackendServiceArgs.builder()
.affinityCookieTtlSec(0)
.backends(RegionBackendServiceBackendArgs.builder()
.group("string")
.maxConnections(0)
.customMetrics(RegionBackendServiceBackendCustomMetricArgs.builder()
.dryRun(false)
.name("string")
.maxUtilization(0)
.build())
.description("string")
.failover(false)
.capacityScaler(0)
.balancingMode("string")
.maxConnectionsPerEndpoint(0)
.maxConnectionsPerInstance(0)
.maxRate(0)
.maxRatePerEndpoint(0)
.maxRatePerInstance(0)
.maxUtilization(0)
.build())
.cdnPolicy(RegionBackendServiceCdnPolicyArgs.builder()
.cacheKeyPolicy(RegionBackendServiceCdnPolicyCacheKeyPolicyArgs.builder()
.includeHost(false)
.includeNamedCookies("string")
.includeProtocol(false)
.includeQueryString(false)
.queryStringBlacklists("string")
.queryStringWhitelists("string")
.build())
.cacheMode("string")
.clientTtl(0)
.defaultTtl(0)
.maxTtl(0)
.negativeCaching(false)
.negativeCachingPolicies(RegionBackendServiceCdnPolicyNegativeCachingPolicyArgs.builder()
.code(0)
.ttl(0)
.build())
.serveWhileStale(0)
.signedUrlCacheMaxAgeSec(0)
.build())
.circuitBreakers(RegionBackendServiceCircuitBreakersArgs.builder()
.connectTimeout(RegionBackendServiceCircuitBreakersConnectTimeoutArgs.builder()
.seconds(0)
.nanos(0)
.build())
.maxConnections(0)
.maxPendingRequests(0)
.maxRequests(0)
.maxRequestsPerConnection(0)
.maxRetries(0)
.build())
.connectionDrainingTimeoutSec(0)
.connectionTrackingPolicy(RegionBackendServiceConnectionTrackingPolicyArgs.builder()
.connectionPersistenceOnUnhealthyBackends("string")
.enableStrongAffinity(false)
.idleTimeoutSec(0)
.trackingMode("string")
.build())
.consistentHash(RegionBackendServiceConsistentHashArgs.builder()
.httpCookie(RegionBackendServiceConsistentHashHttpCookieArgs.builder()
.name("string")
.path("string")
.ttl(RegionBackendServiceConsistentHashHttpCookieTtlArgs.builder()
.seconds(0)
.nanos(0)
.build())
.build())
.httpHeaderName("string")
.minimumRingSize(0)
.build())
.customMetrics(RegionBackendServiceCustomMetricArgs.builder()
.dryRun(false)
.name("string")
.build())
.description("string")
.enableCdn(false)
.failoverPolicy(RegionBackendServiceFailoverPolicyArgs.builder()
.disableConnectionDrainOnFailover(false)
.dropTrafficIfUnhealthy(false)
.failoverRatio(0)
.build())
.healthChecks("string")
.iap(RegionBackendServiceIapArgs.builder()
.enabled(false)
.oauth2ClientId("string")
.oauth2ClientSecret("string")
.oauth2ClientSecretSha256("string")
.build())
.ipAddressSelectionPolicy("string")
.loadBalancingScheme("string")
.localityLbPolicy("string")
.logConfig(RegionBackendServiceLogConfigArgs.builder()
.enable(false)
.optionalFields("string")
.optionalMode("string")
.sampleRate(0)
.build())
.name("string")
.network("string")
.outlierDetection(RegionBackendServiceOutlierDetectionArgs.builder()
.baseEjectionTime(RegionBackendServiceOutlierDetectionBaseEjectionTimeArgs.builder()
.seconds(0)
.nanos(0)
.build())
.consecutiveErrors(0)
.consecutiveGatewayFailure(0)
.enforcingConsecutiveErrors(0)
.enforcingConsecutiveGatewayFailure(0)
.enforcingSuccessRate(0)
.interval(RegionBackendServiceOutlierDetectionIntervalArgs.builder()
.seconds(0)
.nanos(0)
.build())
.maxEjectionPercent(0)
.successRateMinimumHosts(0)
.successRateRequestVolume(0)
.successRateStdevFactor(0)
.build())
.portName("string")
.project("string")
.protocol("string")
.region("string")
.securityPolicy("string")
.sessionAffinity("string")
.strongSessionAffinityCookie(RegionBackendServiceStrongSessionAffinityCookieArgs.builder()
.name("string")
.path("string")
.ttl(RegionBackendServiceStrongSessionAffinityCookieTtlArgs.builder()
.seconds(0)
.nanos(0)
.build())
.build())
.subsetting(RegionBackendServiceSubsettingArgs.builder()
.policy("string")
.build())
.timeoutSec(0)
.build());
region_backend_service_resource = gcp.compute.RegionBackendService("regionBackendServiceResource",
affinity_cookie_ttl_sec=0,
backends=[{
"group": "string",
"max_connections": 0,
"custom_metrics": [{
"dry_run": False,
"name": "string",
"max_utilization": 0,
}],
"description": "string",
"failover": False,
"capacity_scaler": 0,
"balancing_mode": "string",
"max_connections_per_endpoint": 0,
"max_connections_per_instance": 0,
"max_rate": 0,
"max_rate_per_endpoint": 0,
"max_rate_per_instance": 0,
"max_utilization": 0,
}],
cdn_policy={
"cache_key_policy": {
"include_host": False,
"include_named_cookies": ["string"],
"include_protocol": False,
"include_query_string": False,
"query_string_blacklists": ["string"],
"query_string_whitelists": ["string"],
},
"cache_mode": "string",
"client_ttl": 0,
"default_ttl": 0,
"max_ttl": 0,
"negative_caching": False,
"negative_caching_policies": [{
"code": 0,
"ttl": 0,
}],
"serve_while_stale": 0,
"signed_url_cache_max_age_sec": 0,
},
circuit_breakers={
"connect_timeout": {
"seconds": 0,
"nanos": 0,
},
"max_connections": 0,
"max_pending_requests": 0,
"max_requests": 0,
"max_requests_per_connection": 0,
"max_retries": 0,
},
connection_draining_timeout_sec=0,
connection_tracking_policy={
"connection_persistence_on_unhealthy_backends": "string",
"enable_strong_affinity": False,
"idle_timeout_sec": 0,
"tracking_mode": "string",
},
consistent_hash={
"http_cookie": {
"name": "string",
"path": "string",
"ttl": {
"seconds": 0,
"nanos": 0,
},
},
"http_header_name": "string",
"minimum_ring_size": 0,
},
custom_metrics=[{
"dry_run": False,
"name": "string",
}],
description="string",
enable_cdn=False,
failover_policy={
"disable_connection_drain_on_failover": False,
"drop_traffic_if_unhealthy": False,
"failover_ratio": 0,
},
health_checks="string",
iap={
"enabled": False,
"oauth2_client_id": "string",
"oauth2_client_secret": "string",
"oauth2_client_secret_sha256": "string",
},
ip_address_selection_policy="string",
load_balancing_scheme="string",
locality_lb_policy="string",
log_config={
"enable": False,
"optional_fields": ["string"],
"optional_mode": "string",
"sample_rate": 0,
},
name="string",
network="string",
outlier_detection={
"base_ejection_time": {
"seconds": 0,
"nanos": 0,
},
"consecutive_errors": 0,
"consecutive_gateway_failure": 0,
"enforcing_consecutive_errors": 0,
"enforcing_consecutive_gateway_failure": 0,
"enforcing_success_rate": 0,
"interval": {
"seconds": 0,
"nanos": 0,
},
"max_ejection_percent": 0,
"success_rate_minimum_hosts": 0,
"success_rate_request_volume": 0,
"success_rate_stdev_factor": 0,
},
port_name="string",
project="string",
protocol="string",
region="string",
security_policy="string",
session_affinity="string",
strong_session_affinity_cookie={
"name": "string",
"path": "string",
"ttl": {
"seconds": 0,
"nanos": 0,
},
},
subsetting={
"policy": "string",
},
timeout_sec=0)
const regionBackendServiceResource = new gcp.compute.RegionBackendService("regionBackendServiceResource", {
affinityCookieTtlSec: 0,
backends: [{
group: "string",
maxConnections: 0,
customMetrics: [{
dryRun: false,
name: "string",
maxUtilization: 0,
}],
description: "string",
failover: false,
capacityScaler: 0,
balancingMode: "string",
maxConnectionsPerEndpoint: 0,
maxConnectionsPerInstance: 0,
maxRate: 0,
maxRatePerEndpoint: 0,
maxRatePerInstance: 0,
maxUtilization: 0,
}],
cdnPolicy: {
cacheKeyPolicy: {
includeHost: false,
includeNamedCookies: ["string"],
includeProtocol: false,
includeQueryString: false,
queryStringBlacklists: ["string"],
queryStringWhitelists: ["string"],
},
cacheMode: "string",
clientTtl: 0,
defaultTtl: 0,
maxTtl: 0,
negativeCaching: false,
negativeCachingPolicies: [{
code: 0,
ttl: 0,
}],
serveWhileStale: 0,
signedUrlCacheMaxAgeSec: 0,
},
circuitBreakers: {
connectTimeout: {
seconds: 0,
nanos: 0,
},
maxConnections: 0,
maxPendingRequests: 0,
maxRequests: 0,
maxRequestsPerConnection: 0,
maxRetries: 0,
},
connectionDrainingTimeoutSec: 0,
connectionTrackingPolicy: {
connectionPersistenceOnUnhealthyBackends: "string",
enableStrongAffinity: false,
idleTimeoutSec: 0,
trackingMode: "string",
},
consistentHash: {
httpCookie: {
name: "string",
path: "string",
ttl: {
seconds: 0,
nanos: 0,
},
},
httpHeaderName: "string",
minimumRingSize: 0,
},
customMetrics: [{
dryRun: false,
name: "string",
}],
description: "string",
enableCdn: false,
failoverPolicy: {
disableConnectionDrainOnFailover: false,
dropTrafficIfUnhealthy: false,
failoverRatio: 0,
},
healthChecks: "string",
iap: {
enabled: false,
oauth2ClientId: "string",
oauth2ClientSecret: "string",
oauth2ClientSecretSha256: "string",
},
ipAddressSelectionPolicy: "string",
loadBalancingScheme: "string",
localityLbPolicy: "string",
logConfig: {
enable: false,
optionalFields: ["string"],
optionalMode: "string",
sampleRate: 0,
},
name: "string",
network: "string",
outlierDetection: {
baseEjectionTime: {
seconds: 0,
nanos: 0,
},
consecutiveErrors: 0,
consecutiveGatewayFailure: 0,
enforcingConsecutiveErrors: 0,
enforcingConsecutiveGatewayFailure: 0,
enforcingSuccessRate: 0,
interval: {
seconds: 0,
nanos: 0,
},
maxEjectionPercent: 0,
successRateMinimumHosts: 0,
successRateRequestVolume: 0,
successRateStdevFactor: 0,
},
portName: "string",
project: "string",
protocol: "string",
region: "string",
securityPolicy: "string",
sessionAffinity: "string",
strongSessionAffinityCookie: {
name: "string",
path: "string",
ttl: {
seconds: 0,
nanos: 0,
},
},
subsetting: {
policy: "string",
},
timeoutSec: 0,
});
type: gcp:compute:RegionBackendService
properties:
affinityCookieTtlSec: 0
backends:
- balancingMode: string
capacityScaler: 0
customMetrics:
- dryRun: false
maxUtilization: 0
name: string
description: string
failover: false
group: string
maxConnections: 0
maxConnectionsPerEndpoint: 0
maxConnectionsPerInstance: 0
maxRate: 0
maxRatePerEndpoint: 0
maxRatePerInstance: 0
maxUtilization: 0
cdnPolicy:
cacheKeyPolicy:
includeHost: false
includeNamedCookies:
- string
includeProtocol: false
includeQueryString: false
queryStringBlacklists:
- string
queryStringWhitelists:
- string
cacheMode: string
clientTtl: 0
defaultTtl: 0
maxTtl: 0
negativeCaching: false
negativeCachingPolicies:
- code: 0
ttl: 0
serveWhileStale: 0
signedUrlCacheMaxAgeSec: 0
circuitBreakers:
connectTimeout:
nanos: 0
seconds: 0
maxConnections: 0
maxPendingRequests: 0
maxRequests: 0
maxRequestsPerConnection: 0
maxRetries: 0
connectionDrainingTimeoutSec: 0
connectionTrackingPolicy:
connectionPersistenceOnUnhealthyBackends: string
enableStrongAffinity: false
idleTimeoutSec: 0
trackingMode: string
consistentHash:
httpCookie:
name: string
path: string
ttl:
nanos: 0
seconds: 0
httpHeaderName: string
minimumRingSize: 0
customMetrics:
- dryRun: false
name: string
description: string
enableCdn: false
failoverPolicy:
disableConnectionDrainOnFailover: false
dropTrafficIfUnhealthy: false
failoverRatio: 0
healthChecks: string
iap:
enabled: false
oauth2ClientId: string
oauth2ClientSecret: string
oauth2ClientSecretSha256: string
ipAddressSelectionPolicy: string
loadBalancingScheme: string
localityLbPolicy: string
logConfig:
enable: false
optionalFields:
- string
optionalMode: string
sampleRate: 0
name: string
network: string
outlierDetection:
baseEjectionTime:
nanos: 0
seconds: 0
consecutiveErrors: 0
consecutiveGatewayFailure: 0
enforcingConsecutiveErrors: 0
enforcingConsecutiveGatewayFailure: 0
enforcingSuccessRate: 0
interval:
nanos: 0
seconds: 0
maxEjectionPercent: 0
successRateMinimumHosts: 0
successRateRequestVolume: 0
successRateStdevFactor: 0
portName: string
project: string
protocol: string
region: string
securityPolicy: string
sessionAffinity: string
strongSessionAffinityCookie:
name: string
path: string
ttl:
nanos: 0
seconds: 0
subsetting:
policy: string
timeoutSec: 0
RegionBackendService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RegionBackendService resource accepts the following input properties:
- int
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- Backends
List<Region
Backend Service Backend> - The set of backends that serve this RegionBackendService. Structure is documented below.
- Cdn
Policy RegionBackend Service Cdn Policy - Cloud CDN configuration for this BackendService. Structure is documented below.
- Circuit
Breakers RegionBackend Service Circuit Breakers - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Connection
Draining intTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- Connection
Tracking RegionPolicy Backend Service Connection Tracking Policy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- Consistent
Hash RegionBackend Service Consistent Hash - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- Custom
Metrics List<RegionBackend Service Custom Metric> - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- Description string
- An optional description of this resource.
- Enable
Cdn bool - If true, enable Cloud CDN for this RegionBackendService.
- Failover
Policy RegionBackend Service Failover Policy - Policy for failovers. Structure is documented below.
- Health
Checks string - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- Iap
Region
Backend Service Iap - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- Ip
Address stringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - Load
Balancing Scheme 
Changes to this property will trigger replacement. - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - Locality
Lb stringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- Log
Config RegionBackend Service Log Config - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- Name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - Network string
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- Outlier
Detection RegionBackend Service Outlier Detection - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Port
Name string - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- Project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Protocol string
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - Region string
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- Security
Policy string - The security policy associated with this backend service.
- Session
Affinity string - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- Subsetting
Region
Backend Service Subsetting - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- Timeout
Sec int - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- int
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- Backends
[]Region
Backend Service Backend Args - The set of backends that serve this RegionBackendService. Structure is documented below.
- Cdn
Policy RegionBackend Service Cdn Policy Args - Cloud CDN configuration for this BackendService. Structure is documented below.
- Circuit
Breakers RegionBackend Service Circuit Breakers Args - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Connection
Draining intTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- Connection
Tracking RegionPolicy Backend Service Connection Tracking Policy Args - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- Consistent
Hash RegionBackend Service Consistent Hash Args - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- Custom
Metrics []RegionBackend Service Custom Metric Args - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- Description string
- An optional description of this resource.
- Enable
Cdn bool - If true, enable Cloud CDN for this RegionBackendService.
- Failover
Policy RegionBackend Service Failover Policy Args - Policy for failovers. Structure is documented below.
- Health
Checks string - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- Iap
Region
Backend Service Iap Args - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- Ip
Address stringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - Load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - Locality
Lb stringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- Log
Config RegionBackend Service Log Config Args - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- Name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - Network string
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- Outlier
Detection RegionBackend Service Outlier Detection Args - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Port
Name string - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- Project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Protocol string
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - Region string
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- Security
Policy string - The security policy associated with this backend service.
- Session
Affinity string - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie Args - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- Subsetting
Region
Backend Service Subsetting Args - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- Timeout
Sec int - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- Integer
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends
List<Region
Backend Service Backend> - The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn
Policy RegionBackend Service Cdn Policy - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit
Breakers RegionBackend Service Circuit Breakers - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection
Draining IntegerTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection
Tracking RegionPolicy Backend Service Connection Tracking Policy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent
Hash RegionBackend Service Consistent Hash - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- custom
Metrics List<RegionBackend Service Custom Metric> - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description String
- An optional description of this resource.
- enable
Cdn Boolean - If true, enable Cloud CDN for this RegionBackendService.
- failover
Policy RegionBackend Service Failover Policy - Policy for failovers. Structure is documented below.
- health
Checks String - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap
Region
Backend Service Iap - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip
Address StringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality
Lb StringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log
Config RegionBackend Service Log Config - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network String
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier
Detection RegionBackend Service Outlier Detection - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port
Name String - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol String
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region String
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security
Policy String - The security policy associated with this backend service.
- session
Affinity String - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting
Region
Backend Service Subsetting - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout
Sec Integer - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- number
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends
Region
Backend Service Backend[] - The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn
Policy RegionBackend Service Cdn Policy - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit
Breakers RegionBackend Service Circuit Breakers - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection
Draining numberTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection
Tracking RegionPolicy Backend Service Connection Tracking Policy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent
Hash RegionBackend Service Consistent Hash - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- custom
Metrics RegionBackend Service Custom Metric[] - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description string
- An optional description of this resource.
- enable
Cdn boolean - If true, enable Cloud CDN for this RegionBackendService.
- failover
Policy RegionBackend Service Failover Policy - Policy for failovers. Structure is documented below.
- health
Checks string - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap
Region
Backend Service Iap - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip
Address stringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality
Lb stringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log
Config RegionBackend Service Log Config - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network string
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier
Detection RegionBackend Service Outlier Detection - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port
Name string - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol string
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region string
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security
Policy string - The security policy associated with this backend service.
- session
Affinity string - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting
Region
Backend Service Subsetting - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout
Sec number - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- int
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends
Sequence[Region
Backend Service Backend Args] - The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn_
policy RegionBackend Service Cdn Policy Args - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit_
breakers RegionBackend Service Circuit Breakers Args - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection_
draining_ inttimeout_ sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection_
tracking_ Regionpolicy Backend Service Connection Tracking Policy Args - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent_
hash RegionBackend Service Consistent Hash Args - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- custom_
metrics Sequence[RegionBackend Service Custom Metric Args] - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description str
- An optional description of this resource.
- enable_
cdn bool - If true, enable Cloud CDN for this RegionBackendService.
- failover_
policy RegionBackend Service Failover Policy Args - Policy for failovers. Structure is documented below.
- health_
checks str - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap
Region
Backend Service Iap Args - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip_
address_ strselection_ policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load_
balancing_ scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality_
lb_ strpolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log_
config RegionBackend Service Log Config Args - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network str
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier_
detection RegionBackend Service Outlier Detection Args - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port_
name str - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol str
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region str
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security_
policy str - The security policy associated with this backend service.
- session_
affinity str - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie Args - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting
Region
Backend Service Subsetting Args - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout_
sec int - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- Number
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends List<Property Map>
- The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn
Policy Property Map - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit
Breakers Property Map - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection
Draining NumberTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection
Tracking Property MapPolicy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent
Hash Property Map - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- custom
Metrics List<Property Map> - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description String
- An optional description of this resource.
- enable
Cdn Boolean - If true, enable Cloud CDN for this RegionBackendService.
- failover
Policy Property Map - Policy for failovers. Structure is documented below.
- health
Checks String - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap Property Map
- Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip
Address StringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality
Lb StringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log
Config Property Map - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network String
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier
Detection Property Map - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port
Name String - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol String
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region String
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security
Policy String - The security policy associated with this backend service.
- session
Affinity String - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. - Property Map
- Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting Property Map
- Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout
Sec Number - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
Outputs
All input properties are implicitly available as output properties. Additionally, the RegionBackendService resource produces the following output properties:
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Fingerprint string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Generated
Id int - The unique identifier for the resource. This identifier is defined by the server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Self
Link string - The URI of the created resource.
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Fingerprint string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Generated
Id int - The unique identifier for the resource. This identifier is defined by the server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Self
Link string - The URI of the created resource.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- fingerprint String
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated
Id Integer - The unique identifier for the resource. This identifier is defined by the server.
- id String
- The provider-assigned unique ID for this managed resource.
- self
Link String - The URI of the created resource.
- creation
Timestamp string - Creation timestamp in RFC3339 text format.
- fingerprint string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated
Id number - The unique identifier for the resource. This identifier is defined by the server.
- id string
- The provider-assigned unique ID for this managed resource.
- self
Link string - The URI of the created resource.
- creation_
timestamp str - Creation timestamp in RFC3339 text format.
- fingerprint str
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated_
id int - The unique identifier for the resource. This identifier is defined by the server.
- id str
- The provider-assigned unique ID for this managed resource.
- self_
link str - The URI of the created resource.
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- fingerprint String
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated
Id Number - The unique identifier for the resource. This identifier is defined by the server.
- id String
- The provider-assigned unique ID for this managed resource.
- self
Link String - The URI of the created resource.
Look up Existing RegionBackendService Resource
Get an existing RegionBackendService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RegionBackendServiceState, opts?: CustomResourceOptions): RegionBackendService@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
affinity_cookie_ttl_sec: Optional[int] = None,
backends: Optional[Sequence[RegionBackendServiceBackendArgs]] = None,
cdn_policy: Optional[RegionBackendServiceCdnPolicyArgs] = None,
circuit_breakers: Optional[RegionBackendServiceCircuitBreakersArgs] = None,
connection_draining_timeout_sec: Optional[int] = None,
connection_tracking_policy: Optional[RegionBackendServiceConnectionTrackingPolicyArgs] = None,
consistent_hash: Optional[RegionBackendServiceConsistentHashArgs] = None,
creation_timestamp: Optional[str] = None,
custom_metrics: Optional[Sequence[RegionBackendServiceCustomMetricArgs]] = None,
description: Optional[str] = None,
enable_cdn: Optional[bool] = None,
failover_policy: Optional[RegionBackendServiceFailoverPolicyArgs] = None,
fingerprint: Optional[str] = None,
generated_id: Optional[int] = None,
health_checks: Optional[str] = None,
iap: Optional[RegionBackendServiceIapArgs] = None,
ip_address_selection_policy: Optional[str] = None,
load_balancing_scheme: Optional[str] = None,
locality_lb_policy: Optional[str] = None,
log_config: Optional[RegionBackendServiceLogConfigArgs] = None,
name: Optional[str] = None,
network: Optional[str] = None,
outlier_detection: Optional[RegionBackendServiceOutlierDetectionArgs] = None,
port_name: Optional[str] = None,
project: Optional[str] = None,
protocol: Optional[str] = None,
region: Optional[str] = None,
security_policy: Optional[str] = None,
self_link: Optional[str] = None,
session_affinity: Optional[str] = None,
strong_session_affinity_cookie: Optional[RegionBackendServiceStrongSessionAffinityCookieArgs] = None,
subsetting: Optional[RegionBackendServiceSubsettingArgs] = None,
timeout_sec: Optional[int] = None) -> RegionBackendServicefunc GetRegionBackendService(ctx *Context, name string, id IDInput, state *RegionBackendServiceState, opts ...ResourceOption) (*RegionBackendService, error)public static RegionBackendService Get(string name, Input<string> id, RegionBackendServiceState? state, CustomResourceOptions? opts = null)public static RegionBackendService get(String name, Output<String> id, RegionBackendServiceState state, CustomResourceOptions options)resources: _: type: gcp:compute:RegionBackendService get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- int
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- Backends
List<Region
Backend Service Backend> - The set of backends that serve this RegionBackendService. Structure is documented below.
- Cdn
Policy RegionBackend Service Cdn Policy - Cloud CDN configuration for this BackendService. Structure is documented below.
- Circuit
Breakers RegionBackend Service Circuit Breakers - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Connection
Draining intTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- Connection
Tracking RegionPolicy Backend Service Connection Tracking Policy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- Consistent
Hash RegionBackend Service Consistent Hash - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Custom
Metrics List<RegionBackend Service Custom Metric> - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- Description string
- An optional description of this resource.
- Enable
Cdn bool - If true, enable Cloud CDN for this RegionBackendService.
- Failover
Policy RegionBackend Service Failover Policy - Policy for failovers. Structure is documented below.
- Fingerprint string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Generated
Id int - The unique identifier for the resource. This identifier is defined by the server.
- Health
Checks string - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- Iap
Region
Backend Service Iap - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- Ip
Address stringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - Load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - Locality
Lb stringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- Log
Config RegionBackend Service Log Config - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- Name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - Network string
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- Outlier
Detection RegionBackend Service Outlier Detection - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Port
Name string - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- Project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Protocol string
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - Region string
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- Security
Policy string - The security policy associated with this backend service.
- Self
Link string - The URI of the created resource.
- Session
Affinity string - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- Subsetting
Region
Backend Service Subsetting - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- Timeout
Sec int - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- int
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- Backends
[]Region
Backend Service Backend Args - The set of backends that serve this RegionBackendService. Structure is documented below.
- Cdn
Policy RegionBackend Service Cdn Policy Args - Cloud CDN configuration for this BackendService. Structure is documented below.
- Circuit
Breakers RegionBackend Service Circuit Breakers Args - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Connection
Draining intTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- Connection
Tracking RegionPolicy Backend Service Connection Tracking Policy Args - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- Consistent
Hash RegionBackend Service Consistent Hash Args - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- Creation
Timestamp string - Creation timestamp in RFC3339 text format.
- Custom
Metrics []RegionBackend Service Custom Metric Args - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- Description string
- An optional description of this resource.
- Enable
Cdn bool - If true, enable Cloud CDN for this RegionBackendService.
- Failover
Policy RegionBackend Service Failover Policy Args - Policy for failovers. Structure is documented below.
- Fingerprint string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Generated
Id int - The unique identifier for the resource. This identifier is defined by the server.
- Health
Checks string - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- Iap
Region
Backend Service Iap Args - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- Ip
Address stringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - Load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - Locality
Lb stringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- Log
Config RegionBackend Service Log Config Args - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- Name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - Network string
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- Outlier
Detection RegionBackend Service Outlier Detection Args - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - Port
Name string - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- Project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Protocol string
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - Region string
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- Security
Policy string - The security policy associated with this backend service.
- Self
Link string - The URI of the created resource.
- Session
Affinity string - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie Args - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- Subsetting
Region
Backend Service Subsetting Args - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- Timeout
Sec int - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- Integer
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends
List<Region
Backend Service Backend> - The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn
Policy RegionBackend Service Cdn Policy - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit
Breakers RegionBackend Service Circuit Breakers - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection
Draining IntegerTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection
Tracking RegionPolicy Backend Service Connection Tracking Policy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent
Hash RegionBackend Service Consistent Hash - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- custom
Metrics List<RegionBackend Service Custom Metric> - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description String
- An optional description of this resource.
- enable
Cdn Boolean - If true, enable Cloud CDN for this RegionBackendService.
- failover
Policy RegionBackend Service Failover Policy - Policy for failovers. Structure is documented below.
- fingerprint String
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated
Id Integer - The unique identifier for the resource. This identifier is defined by the server.
- health
Checks String - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap
Region
Backend Service Iap - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip
Address StringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality
Lb StringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log
Config RegionBackend Service Log Config - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network String
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier
Detection RegionBackend Service Outlier Detection - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port
Name String - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol String
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region String
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security
Policy String - The security policy associated with this backend service.
- self
Link String - The URI of the created resource.
- session
Affinity String - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting
Region
Backend Service Subsetting - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout
Sec Integer - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- number
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends
Region
Backend Service Backend[] - The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn
Policy RegionBackend Service Cdn Policy - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit
Breakers RegionBackend Service Circuit Breakers - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection
Draining numberTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection
Tracking RegionPolicy Backend Service Connection Tracking Policy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent
Hash RegionBackend Service Consistent Hash - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- creation
Timestamp string - Creation timestamp in RFC3339 text format.
- custom
Metrics RegionBackend Service Custom Metric[] - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description string
- An optional description of this resource.
- enable
Cdn boolean - If true, enable Cloud CDN for this RegionBackendService.
- failover
Policy RegionBackend Service Failover Policy - Policy for failovers. Structure is documented below.
- fingerprint string
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated
Id number - The unique identifier for the resource. This identifier is defined by the server.
- health
Checks string - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap
Region
Backend Service Iap - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip
Address stringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality
Lb stringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log
Config RegionBackend Service Log Config - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network string
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier
Detection RegionBackend Service Outlier Detection - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port
Name string - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol string
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region string
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security
Policy string - The security policy associated with this backend service.
- self
Link string - The URI of the created resource.
- session
Affinity string - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting
Region
Backend Service Subsetting - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout
Sec number - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- int
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends
Sequence[Region
Backend Service Backend Args] - The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn_
policy RegionBackend Service Cdn Policy Args - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit_
breakers RegionBackend Service Circuit Breakers Args - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection_
draining_ inttimeout_ sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection_
tracking_ Regionpolicy Backend Service Connection Tracking Policy Args - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent_
hash RegionBackend Service Consistent Hash Args - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- creation_
timestamp str - Creation timestamp in RFC3339 text format.
- custom_
metrics Sequence[RegionBackend Service Custom Metric Args] - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description str
- An optional description of this resource.
- enable_
cdn bool - If true, enable Cloud CDN for this RegionBackendService.
- failover_
policy RegionBackend Service Failover Policy Args - Policy for failovers. Structure is documented below.
- fingerprint str
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated_
id int - The unique identifier for the resource. This identifier is defined by the server.
- health_
checks str - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap
Region
Backend Service Iap Args - Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip_
address_ strselection_ policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load_
balancing_ scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality_
lb_ strpolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log_
config RegionBackend Service Log Config Args - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network str
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier_
detection RegionBackend Service Outlier Detection Args - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port_
name str - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol str
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region str
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security_
policy str - The security policy associated with this backend service.
- self_
link str - The URI of the created resource.
- session_
affinity str - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. -
Region
Backend Service Strong Session Affinity Cookie Args - Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting
Region
Backend Service Subsetting Args - Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout_
sec int - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
- Number
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
- backends List<Property Map>
- The set of backends that serve this RegionBackendService. Structure is documented below.
- cdn
Policy Property Map - Cloud CDN configuration for this BackendService. Structure is documented below.
- circuit
Breakers Property Map - Settings controlling the volume of connections to a backend service. This field
is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - connection
Draining NumberTimeout Sec - Time for which instance will be drained (not accept new connections, but still work to finish started).
- connection
Tracking Property MapPolicy - Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.
- consistent
Hash Property Map - Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -
- creation
Timestamp String - Creation timestamp in RFC3339 text format.
- custom
Metrics List<Property Map> - List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.
- description String
- An optional description of this resource.
- enable
Cdn Boolean - If true, enable Cloud CDN for this RegionBackendService.
- failover
Policy Property Map - Policy for failovers. Structure is documented below.
- fingerprint String
- Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- generated
Id Number - The unique identifier for the resource. This identifier is defined by the server.
- health
Checks String - The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.
- iap Property Map
- Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.
- ip
Address StringSelection Policy - Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC).
Possible values are:
IPV4_ONLY,PREFER_IPV6,IPV6_ONLY. - load
Balancing Scheme - Indicates what kind of load balancing this regional backend service
will be used for. A backend service created for one type of load
balancing cannot be used with the other(s). For more information, refer to
Choosing a load balancer.
Default value is
INTERNAL. Possible values are:EXTERNAL,EXTERNAL_MANAGED,INTERNAL,INTERNAL_MANAGED. - locality
Lb StringPolicy - The load balancing algorithm used within the scope of the locality.
The possible values are:
ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order.LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.RANDOM: The load balancer selects a random healthy host.ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824WEIGHTED_MAGLEV: Per-instance weighted Load Balancing via health check reported weights. Only applicable to loadBalancingScheme EXTERNAL. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weight based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.WEIGHTED_ROUND_ROBIN: Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields. locality_lb_policy is applicable to either:- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED.
- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
- A regional backend service with loadBalancingScheme set to EXTERNAL (External Network
Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External
Network Load Balancing. The default is MAGLEV.
If session_affinity is not NONE, and locality_lb_policy is not set to MAGLEV, WEIGHTED_MAGLEV,
or RING_HASH, session affinity settings will not take effect.
Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced
by a URL map that is bound to target gRPC proxy that has validate_for_proxyless
field set to true.
Possible values are:
ROUND_ROBIN,LEAST_REQUEST,RING_HASH,RANDOM,ORIGINAL_DESTINATION,MAGLEV,WEIGHTED_MAGLEV,WEIGHTED_ROUND_ROBIN.
- log
Config Property Map - This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. Structure is documented below.
- name
- Name of the resource. Provided by the client when the resource is
created. The name must be 1-63 characters long, and comply with
RFC1035. Specifically, the name must be 1-63 characters long and match
the regular expression
a-z?which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - network String
- The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
- outlier
Detection Property Map - Settings controlling eviction of unhealthy hosts from the load balancing pool.
This field is applicable only when the
load_balancing_schemeis set to INTERNAL_MANAGED and theprotocolis set to HTTP, HTTPS, or HTTP2. Structure is documented below. - port
Name String - A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of "http" if not given. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).
- project
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- protocol String
- The protocol this RegionBackendService uses to communicate with backends.
The default is HTTP. NOTE: HTTP2 is only valid for beta HTTP/2 load balancer
types and may result in errors if used with the GA API.
Possible values are:
HTTP,HTTPS,HTTP2,SSL,TCP,UDP,GRPC,UNSPECIFIED. - region String
- The Region in which the created backend service should reside. If it is not provided, the provider region is used.
- security
Policy String - The security policy associated with this backend service.
- self
Link String - The URI of the created resource.
- session
Affinity String - Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
Possible values are:
NONE,CLIENT_IP,CLIENT_IP_PORT_PROTO,CLIENT_IP_PROTO,GENERATED_COOKIE,HEADER_FIELD,HTTP_COOKIE,CLIENT_IP_NO_DESTINATION,STRONG_COOKIE_AFFINITY. - Property Map
- Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.
- subsetting Property Map
- Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing. Structure is documented below.
- timeout
Sec Number - The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds.
Supporting Types
RegionBackendServiceBackend, RegionBackendServiceBackendArgs
, RegionBackendServiceBackendArgs
- Group
This property is required. 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_schemeis 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. - Balancing
Mode string - Specifies the balancing mode for this backend.
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION. Possible values are:UTILIZATION,RATE,CONNECTION,CUSTOM_METRICS. - Capacity
Scaler 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].
- Custom
Metrics List<RegionBackend Service Backend Custom Metric> - The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.
- 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.
- 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 intPer Endpoint - 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.
- Max
Connections intPer Instance - The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- 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 doublePer Endpoint - 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.
- Max
Rate doublePer Instance - 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.
- Max
Utilization 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.
- Group
This property is required. 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_schemeis 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. - Balancing
Mode string - Specifies the balancing mode for this backend.
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION. Possible values are:UTILIZATION,RATE,CONNECTION,CUSTOM_METRICS. - Capacity
Scaler float64 - 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].
- Custom
Metrics []RegionBackend Service Backend Custom Metric - The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.
- 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.
- 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 intPer Endpoint - 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.
- Max
Connections intPer Instance - The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- 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 float64Per Endpoint - 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.
- Max
Rate float64Per Instance - 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.
- Max
Utilization 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.
- group
This property is required. 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_schemeis 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. - balancing
Mode String - Specifies the balancing mode for this backend.
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION. Possible values are:UTILIZATION,RATE,CONNECTION,CUSTOM_METRICS. - capacity
Scaler 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].
- custom
Metrics List<RegionBackend Service Backend Custom Metric> - The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.
- 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.
- max
Connections 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.
- max
Connections IntegerPer Endpoint - 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.
- max
Connections IntegerPer Instance - The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- max
Rate 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.
- max
Rate DoublePer Endpoint - 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.
- max
Rate DoublePer Instance - 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.
- max
Utilization 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.
- group
This property is required. 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_schemeis 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. - balancing
Mode string - Specifies the balancing mode for this backend.
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION. Possible values are:UTILIZATION,RATE,CONNECTION,CUSTOM_METRICS. - capacity
Scaler number - 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].
- custom
Metrics RegionBackend Service Backend Custom Metric[] - The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.
- 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.
- max
Connections 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.
- max
Connections numberPer Endpoint - 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.
- max
Connections numberPer Instance - The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- max
Rate 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.
- max
Rate numberPer Endpoint - 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.
- max
Rate numberPer Instance - 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.
- max
Utilization 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.
- group
This property is required. str - 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_schemeis 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. - balancing_
mode str - Specifies the balancing mode for this backend.
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION. Possible values are:UTILIZATION,RATE,CONNECTION,CUSTOM_METRICS. - capacity_
scaler float - 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].
- custom_
metrics Sequence[RegionBackend Service Backend Custom Metric] - The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.
- 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.
- 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_ intper_ endpoint - 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.
- max_
connections_ intper_ instance - The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- 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_ floatper_ endpoint - 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.
- max_
rate_ floatper_ instance - 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.
- 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.
- group
This property is required. 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_schemeis 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. - balancing
Mode String - Specifies the balancing mode for this backend.
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION. Possible values are:UTILIZATION,RATE,CONNECTION,CUSTOM_METRICS. - capacity
Scaler Number - 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].
- custom
Metrics List<Property Map> - The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.
- 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.
- max
Connections 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.
- max
Connections NumberPer Endpoint - 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.
- max
Connections NumberPer Instance - The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
- max
Rate 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.
- max
Rate NumberPer Endpoint - 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.
- max
Rate NumberPer Instance - 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.
- max
Utilization 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.
RegionBackendServiceBackendCustomMetric, RegionBackendServiceBackendCustomMetricArgs
, RegionBackendServiceBackendCustomMetricArgs
- Dry
Run This property is required. bool - If true, the metric data is not used for load balancing.
- Name
This property is required. string - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- Max
Utilization double - Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
- Dry
Run This property is required. bool - If true, the metric data is not used for load balancing.
- Name
This property is required. string - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- Max
Utilization float64 - Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
- dry
Run This property is required. Boolean - If true, the metric data is not used for load balancing.
- name
This property is required. String - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- max
Utilization Double - Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
- dry
Run This property is required. boolean - If true, the metric data is not used for load balancing.
- name
This property is required. string - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- max
Utilization number - Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
- dry_
run This property is required. bool - If true, the metric data is not used for load balancing.
- name
This property is required. str - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- max_
utilization float - Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
- dry
Run This property is required. Boolean - If true, the metric data is not used for load balancing.
- name
This property is required. String - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- max
Utilization Number - Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
RegionBackendServiceCdnPolicy, RegionBackendServiceCdnPolicyArgs
, RegionBackendServiceCdnPolicyArgs
- Cache
Key RegionPolicy Backend Service Cdn Policy Cache Key Policy - The CacheKeyPolicy for this CdnPolicy. Structure is documented below.
- Cache
Mode 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 are:
USE_ORIGIN_HEADERS,FORCE_CACHE_ALL,CACHE_ALL_STATIC. - 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 List<RegionPolicies Backend Service Cdn Policy Negative Caching Policy> - 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. Structure is documented below.
- Serve
While intStale - 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 intCache Max Age Sec - 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.
- Cache
Key RegionPolicy Backend Service Cdn Policy Cache Key Policy - The CacheKeyPolicy for this CdnPolicy. Structure is documented below.
- Cache
Mode 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 are:
USE_ORIGIN_HEADERS,FORCE_CACHE_ALL,CACHE_ALL_STATIC. - 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 []RegionPolicies Backend Service Cdn Policy Negative Caching Policy - 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. Structure is documented below.
- Serve
While intStale - 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 intCache Max Age Sec - 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.
- cache
Key RegionPolicy Backend Service Cdn Policy Cache Key Policy - The CacheKeyPolicy for this CdnPolicy. Structure is documented below.
- cache
Mode 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 are:
USE_ORIGIN_HEADERS,FORCE_CACHE_ALL,CACHE_ALL_STATIC. - client
Ttl Integer - Specifies the maximum allowed TTL for cached content served by this origin.
- default
Ttl 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).
- max
Ttl Integer - Specifies the maximum allowed TTL for cached content served by this origin.
- negative
Caching Boolean - Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
- negative
Caching List<RegionPolicies Backend Service Cdn Policy Negative Caching Policy> - 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. Structure is documented below.
- serve
While IntegerStale - 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 IntegerCache Max Age Sec - 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.
- cache
Key RegionPolicy Backend Service Cdn Policy Cache Key Policy - The CacheKeyPolicy for this CdnPolicy. Structure is documented below.
- cache
Mode 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 are:
USE_ORIGIN_HEADERS,FORCE_CACHE_ALL,CACHE_ALL_STATIC. - client
Ttl number - Specifies the maximum allowed TTL for cached content served by this origin.
- default
Ttl 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).
- max
Ttl number - Specifies the maximum allowed TTL for cached content served by this origin.
- negative
Caching boolean - Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
- negative
Caching RegionPolicies Backend Service Cdn Policy Negative Caching Policy[] - 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. Structure is documented below.
- serve
While numberStale - 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 numberCache Max Age Sec - 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.
- cache_
key_ Regionpolicy Backend Service Cdn Policy Cache Key Policy - The CacheKeyPolicy for this CdnPolicy. Structure is documented below.
- cache_
mode str - 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 are:
USE_ORIGIN_HEADERS,FORCE_CACHE_ALL,CACHE_ALL_STATIC. - 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_ Sequence[Regionpolicies Backend Service Cdn Policy Negative Caching Policy] - 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. Structure is documented below.
- serve_
while_ intstale - 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_ intcache_ max_ age_ sec - 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.
- cache
Key Property MapPolicy - The CacheKeyPolicy for this CdnPolicy. Structure is documented below.
- cache
Mode 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 are:
USE_ORIGIN_HEADERS,FORCE_CACHE_ALL,CACHE_ALL_STATIC. - client
Ttl Number - Specifies the maximum allowed TTL for cached content served by this origin.
- default
Ttl 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).
- max
Ttl Number - Specifies the maximum allowed TTL for cached content served by this origin.
- negative
Caching Boolean - Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects.
- negative
Caching List<Property Map>Policies - 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. Structure is documented below.
- serve
While NumberStale - 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 NumberCache Max Age Sec - 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.
RegionBackendServiceCdnPolicyCacheKeyPolicy, RegionBackendServiceCdnPolicyCacheKeyPolicyArgs
, RegionBackendServiceCdnPolicyCacheKeyPolicyArgs
- Include
Host bool - If true requests to different hosts will be cached separately.
- List<string>
- Names of cookies to include in cache keys.
- Include
Protocol bool - If true, http and https requests will be cached separately.
- Include
Query boolString - 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 List<string>Blacklists - 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 List<string>Whitelists - 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.
- []string
- Names of cookies to include in cache keys.
- Include
Protocol bool - If true, http and https requests will be cached separately.
- Include
Query boolString - 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 []stringBlacklists - 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 []stringWhitelists - 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 Boolean - If true requests to different hosts will be cached separately.
- List<String>
- Names of cookies to include in cache keys.
- include
Protocol Boolean - If true, http and https requests will be cached separately.
- include
Query BooleanString - 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 List<String>Blacklists - 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 List<String>Whitelists - 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 boolean - If true requests to different hosts will be cached separately.
- string[]
- Names of cookies to include in cache keys.
- include
Protocol boolean - If true, http and https requests will be cached separately.
- include
Query booleanString - 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 string[]Blacklists - 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 string[]Whitelists - 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.
- 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_ boolstring - 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_ Sequence[str]blacklists - 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_ Sequence[str]whitelists - 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 Boolean - If true requests to different hosts will be cached separately.
- List<String>
- Names of cookies to include in cache keys.
- include
Protocol Boolean - If true, http and https requests will be cached separately.
- include
Query BooleanString - 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 List<String>Blacklists - 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 List<String>Whitelists - 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.
RegionBackendServiceCdnPolicyNegativeCachingPolicy, RegionBackendServiceCdnPolicyNegativeCachingPolicyArgs
, RegionBackendServiceCdnPolicyNegativeCachingPolicyArgs
- 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.
RegionBackendServiceCircuitBreakers, RegionBackendServiceCircuitBreakersArgs
, RegionBackendServiceCircuitBreakersArgs
- Connect
Timeout RegionBackend Service Circuit Breakers Connect Timeout - The timeout for new network connections to hosts. Structure is documented below.
- Max
Connections int - The maximum number of connections to the backend cluster. Defaults to 1024.
- Max
Pending intRequests - 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 intPer Connection - 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.
- Connect
Timeout RegionBackend Service Circuit Breakers Connect Timeout - The timeout for new network connections to hosts. Structure is documented below.
- Max
Connections int - The maximum number of connections to the backend cluster. Defaults to 1024.
- Max
Pending intRequests - 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 intPer Connection - 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.
- connect
Timeout RegionBackend Service Circuit Breakers Connect Timeout - The timeout for new network connections to hosts. Structure is documented below.
- max
Connections Integer - The maximum number of connections to the backend cluster. Defaults to 1024.
- max
Pending IntegerRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- max
Requests Integer - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- max
Requests IntegerPer Connection - 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 Integer - The maximum number of parallel retries to the backend cluster. Defaults to 3.
- connect
Timeout RegionBackend Service Circuit Breakers Connect Timeout - The timeout for new network connections to hosts. Structure is documented below.
- max
Connections number - The maximum number of connections to the backend cluster. Defaults to 1024.
- max
Pending numberRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- max
Requests number - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- max
Requests numberPer Connection - 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 number - The maximum number of parallel retries to the backend cluster. Defaults to 3.
- connect_
timeout RegionBackend Service Circuit Breakers Connect Timeout - The timeout for new network connections to hosts. Structure is documented below.
- max_
connections int - The maximum number of connections to the backend cluster. Defaults to 1024.
- max_
pending_ intrequests - 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_ intper_ connection - 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.
- connect
Timeout Property Map - The timeout for new network connections to hosts. Structure is documented below.
- max
Connections Number - The maximum number of connections to the backend cluster. Defaults to 1024.
- max
Pending NumberRequests - The maximum number of pending requests to the backend cluster. Defaults to 1024.
- max
Requests Number - The maximum number of parallel requests to the backend cluster. Defaults to 1024.
- max
Requests NumberPer Connection - 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 Number - The maximum number of parallel retries to the backend cluster. Defaults to 3.
RegionBackendServiceCircuitBreakersConnectTimeout, RegionBackendServiceCircuitBreakersConnectTimeoutArgs
, RegionBackendServiceCircuitBreakersConnectTimeoutArgs
- Seconds
This property is required. 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
This property is required. 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
This property is required. Integer - 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
This property is required. number - 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
This property is required. 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
This property is required. Number - 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.
RegionBackendServiceConnectionTrackingPolicy, RegionBackendServiceConnectionTrackingPolicyArgs
, RegionBackendServiceConnectionTrackingPolicyArgs
- Connection
Persistence stringOn Unhealthy Backends - 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 toNEVER_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 toALWAYS_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 isDEFAULT_FOR_PROTOCOL. Possible values are:DEFAULT_FOR_PROTOCOL,NEVER_PERSIST,ALWAYS_PERSIST. - Enable
Strong boolAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- Idle
Timeout intSec - 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 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 isPER_CONNECTION. Possible values are:PER_CONNECTION,PER_SESSION.
- Connection
Persistence stringOn Unhealthy Backends - 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 toNEVER_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 toALWAYS_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 isDEFAULT_FOR_PROTOCOL. Possible values are:DEFAULT_FOR_PROTOCOL,NEVER_PERSIST,ALWAYS_PERSIST. - Enable
Strong boolAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- Idle
Timeout intSec - 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 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 isPER_CONNECTION. Possible values are:PER_CONNECTION,PER_SESSION.
- connection
Persistence StringOn Unhealthy Backends - 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 toNEVER_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 toALWAYS_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 isDEFAULT_FOR_PROTOCOL. Possible values are:DEFAULT_FOR_PROTOCOL,NEVER_PERSIST,ALWAYS_PERSIST. - enable
Strong BooleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout IntegerSec - 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 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 isPER_CONNECTION. Possible values are:PER_CONNECTION,PER_SESSION.
- connection
Persistence stringOn Unhealthy Backends - 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 toNEVER_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 toALWAYS_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 isDEFAULT_FOR_PROTOCOL. Possible values are:DEFAULT_FOR_PROTOCOL,NEVER_PERSIST,ALWAYS_PERSIST. - enable
Strong booleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout numberSec - 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 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 isPER_CONNECTION. Possible values are:PER_CONNECTION,PER_SESSION.
- connection_
persistence_ stron_ unhealthy_ backends - 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 toNEVER_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 toALWAYS_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 isDEFAULT_FOR_PROTOCOL. Possible values are:DEFAULT_FOR_PROTOCOL,NEVER_PERSIST,ALWAYS_PERSIST. - enable_
strong_ boolaffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle_
timeout_ intsec - 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 - 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 isPER_CONNECTION. Possible values are:PER_CONNECTION,PER_SESSION.
- connection
Persistence StringOn Unhealthy Backends - 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 toNEVER_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 toALWAYS_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 isDEFAULT_FOR_PROTOCOL. Possible values are:DEFAULT_FOR_PROTOCOL,NEVER_PERSIST,ALWAYS_PERSIST. - enable
Strong BooleanAffinity - Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.
- idle
Timeout NumberSec - 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 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 isPER_CONNECTION. Possible values are:PER_CONNECTION,PER_SESSION.
RegionBackendServiceConsistentHash, RegionBackendServiceConsistentHashArgs
, RegionBackendServiceConsistentHashArgs
-
Region
Backend Service Consistent Hash Http Cookie - 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. Structure is documented below.
- Http
Header stringName - 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 intSize - 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.
-
Region
Backend Service Consistent Hash Http Cookie - 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. Structure is documented below.
- Http
Header stringName - 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 intSize - 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.
-
Region
Backend Service Consistent Hash Http Cookie - 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. Structure is documented below.
- http
Header StringName - 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 IntegerSize - 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.
-
Region
Backend Service Consistent Hash Http Cookie - 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. Structure is documented below.
- http
Header stringName - 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 numberSize - 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.
-
Region
Backend Service Consistent Hash Http Cookie - 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. Structure is documented below.
- http_
header_ strname - 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_ intsize - 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.
- 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. Structure is documented below.
- http
Header StringName - 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 NumberSize - 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.
RegionBackendServiceConsistentHashHttpCookie, RegionBackendServiceConsistentHashHttpCookieArgs
, RegionBackendServiceConsistentHashHttpCookieArgs
- Name string
- Name of the cookie.
- Path string
- Path to set for the cookie.
- Ttl
Region
Backend Service Consistent Hash Http Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- Name string
- Name of the cookie.
- Path string
- Path to set for the cookie.
- Ttl
Region
Backend Service Consistent Hash Http Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name String
- Name of the cookie.
- path String
- Path to set for the cookie.
- ttl
Region
Backend Service Consistent Hash Http Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name string
- Name of the cookie.
- path string
- Path to set for the cookie.
- ttl
Region
Backend Service Consistent Hash Http Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name str
- Name of the cookie.
- path str
- Path to set for the cookie.
- ttl
Region
Backend Service Consistent Hash Http Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name String
- Name of the cookie.
- path String
- Path to set for the cookie.
- ttl Property Map
- Lifetime of the cookie. Structure is documented below.
RegionBackendServiceConsistentHashHttpCookieTtl, RegionBackendServiceConsistentHashHttpCookieTtlArgs
, RegionBackendServiceConsistentHashHttpCookieTtlArgs
- Seconds
This property is required. 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
This property is required. 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
This property is required. Integer - 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
This property is required. number - 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
This property is required. 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
This property is required. Number - 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.
RegionBackendServiceCustomMetric, RegionBackendServiceCustomMetricArgs
, RegionBackendServiceCustomMetricArgs
- Dry
Run This property is required. bool - If true, the metric data is not used for load balancing.
- Name
This property is required. string - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- Dry
Run This property is required. bool - If true, the metric data is not used for load balancing.
- Name
This property is required. string - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- dry
Run This property is required. Boolean - If true, the metric data is not used for load balancing.
- name
This property is required. String - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- dry
Run This property is required. boolean - If true, the metric data is not used for load balancing.
- name
This property is required. string - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- dry_
run This property is required. bool - If true, the metric data is not used for load balancing.
- name
This property is required. str - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
- dry
Run This property is required. Boolean - If true, the metric data is not used for load balancing.
- name
This property is required. String - Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
RegionBackendServiceFailoverPolicy, RegionBackendServiceFailoverPolicyArgs
, RegionBackendServiceFailoverPolicyArgs
- Disable
Connection boolDrain On Failover - 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 boolIf Unhealthy - 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 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.
- Disable
Connection boolDrain On Failover - 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 boolIf Unhealthy - 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 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.
- disable
Connection BooleanDrain On Failover - 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 BooleanIf Unhealthy - 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 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.
- disable
Connection booleanDrain On Failover - 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 booleanIf Unhealthy - 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 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_ booldrain_ on_ failover - 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_ boolif_ unhealthy - 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.
- disable
Connection BooleanDrain On Failover - 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 BooleanIf Unhealthy - 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 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.
RegionBackendServiceIap, RegionBackendServiceIapArgs
, RegionBackendServiceIapArgs
- Enabled
This property is required. bool - Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2Client
Id string - OAuth2 Client ID for IAP
- Oauth2Client
Secret string - OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.
- Oauth2Client
Secret stringSha256 - (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.
- Enabled
This property is required. bool - Whether the serving infrastructure will authenticate and authorize all incoming requests.
- Oauth2Client
Id string - OAuth2 Client ID for IAP
- Oauth2Client
Secret string - OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.
- Oauth2Client
Secret stringSha256 - (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.
- enabled
This property is required. Boolean - Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2Client
Id String - OAuth2 Client ID for IAP
- oauth2Client
Secret String - OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.
- oauth2Client
Secret StringSha256 - (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.
- enabled
This property is required. boolean - Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2Client
Id string - OAuth2 Client ID for IAP
- oauth2Client
Secret string - OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.
- oauth2Client
Secret stringSha256 - (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.
- enabled
This property is required. bool - Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2_
client_ strid - OAuth2 Client ID for IAP
- oauth2_
client_ strsecret - OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.
- oauth2_
client_ strsecret_ sha256 - (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.
- enabled
This property is required. Boolean - Whether the serving infrastructure will authenticate and authorize all incoming requests.
- oauth2Client
Id String - OAuth2 Client ID for IAP
- oauth2Client
Secret String - OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.
- oauth2Client
Secret StringSha256 - (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.
RegionBackendServiceLogConfig, RegionBackendServiceLogConfigArgs
, RegionBackendServiceLogConfigArgs
- Enable bool
- Whether to enable logging for the load balancer traffic served by this backend service.
- Optional
Fields List<string> - Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
- Optional
Mode string - Specifies the optional logging mode for the load balancer traffic.
Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM.
Possible values are:
INCLUDE_ALL_OPTIONAL,EXCLUDE_ALL_OPTIONAL,CUSTOM. - Sample
Rate 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.
- Optional
Fields []string - Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
- Optional
Mode string - Specifies the optional logging mode for the load balancer traffic.
Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM.
Possible values are:
INCLUDE_ALL_OPTIONAL,EXCLUDE_ALL_OPTIONAL,CUSTOM. - Sample
Rate 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.
- optional
Fields List<String> - Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
- optional
Mode String - Specifies the optional logging mode for the load balancer traffic.
Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM.
Possible values are:
INCLUDE_ALL_OPTIONAL,EXCLUDE_ALL_OPTIONAL,CUSTOM. - sample
Rate 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.
- optional
Fields string[] - Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
- optional
Mode string - Specifies the optional logging mode for the load balancer traffic.
Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM.
Possible values are:
INCLUDE_ALL_OPTIONAL,EXCLUDE_ALL_OPTIONAL,CUSTOM. - sample
Rate 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 are:
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.
- optional
Fields List<String> - Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.
- optional
Mode String - Specifies the optional logging mode for the load balancer traffic.
Supported values: INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM.
Possible values are:
INCLUDE_ALL_OPTIONAL,EXCLUDE_ALL_OPTIONAL,CUSTOM. - sample
Rate 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.
RegionBackendServiceOutlierDetection, RegionBackendServiceOutlierDetectionArgs
, RegionBackendServiceOutlierDetectionArgs
- Base
Ejection RegionTime Backend Service Outlier Detection Base Ejection Time - 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. Structure is documented below.
- 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 intFailure - 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 intErrors - 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 intGateway Failure - 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 intRate - 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.
- Interval
Region
Backend Service Outlier Detection Interval - 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. Structure is documented below.
- Max
Ejection intPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- Success
Rate intMinimum Hosts - 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 intRequest Volume - 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 intStdev Factor - 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 RegionTime Backend Service Outlier Detection Base Ejection Time - 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. Structure is documented below.
- 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 intFailure - 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 intErrors - 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 intGateway Failure - 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 intRate - 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.
- Interval
Region
Backend Service Outlier Detection Interval - 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. Structure is documented below.
- Max
Ejection intPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- Success
Rate intMinimum Hosts - 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 intRequest Volume - 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 intStdev Factor - 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 RegionTime Backend Service Outlier Detection Base Ejection Time - 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. Structure is documented below.
- consecutive
Errors 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.
- consecutive
Gateway IntegerFailure - 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 IntegerErrors - 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 IntegerGateway Failure - 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 IntegerRate - 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.
- interval
Region
Backend Service Outlier Detection Interval - 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. Structure is documented below.
- max
Ejection IntegerPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success
Rate IntegerMinimum Hosts - 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 IntegerRequest Volume - 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 IntegerStdev Factor - 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 RegionTime Backend Service Outlier Detection Base Ejection Time - 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. Structure is documented below.
- consecutive
Errors 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.
- consecutive
Gateway numberFailure - 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 numberErrors - 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 numberGateway Failure - 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 numberRate - 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.
- interval
Region
Backend Service Outlier Detection Interval - 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. Structure is documented below.
- max
Ejection numberPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success
Rate numberMinimum Hosts - 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 numberRequest Volume - 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 numberStdev Factor - 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_ Regiontime Backend Service Outlier Detection Base Ejection Time - 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. Structure is documented below.
- 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_ intfailure - 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_ interrors - 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_ intgateway_ failure - 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_ intrate - 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.
- interval
Region
Backend Service Outlier Detection Interval - 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. Structure is documented below.
- max_
ejection_ intpercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success_
rate_ intminimum_ hosts - 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_ intrequest_ volume - 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_ intstdev_ factor - 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 Property MapTime - 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. Structure is documented below.
- consecutive
Errors 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.
- consecutive
Gateway NumberFailure - 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 NumberErrors - 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 NumberGateway Failure - 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 NumberRate - 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.
- interval 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. Structure is documented below.
- max
Ejection NumberPercent - Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.
- success
Rate NumberMinimum Hosts - 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 NumberRequest Volume - 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 NumberStdev Factor - 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.
RegionBackendServiceOutlierDetectionBaseEjectionTime, RegionBackendServiceOutlierDetectionBaseEjectionTimeArgs
, RegionBackendServiceOutlierDetectionBaseEjectionTimeArgs
- Seconds
This property is required. 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- Seconds
This property is required. 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. Integer - 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. number - 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. Number - 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
RegionBackendServiceOutlierDetectionInterval, RegionBackendServiceOutlierDetectionIntervalArgs
, RegionBackendServiceOutlierDetectionIntervalArgs
- Seconds
This property is required. 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- Seconds
This property is required. 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. Integer - 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. number - 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
- seconds
This property is required. Number - 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
secondsfield and a positivenanosfield. Must be from 0 to 999,999,999 inclusive.
RegionBackendServiceStrongSessionAffinityCookie, RegionBackendServiceStrongSessionAffinityCookieArgs
, RegionBackendServiceStrongSessionAffinityCookieArgs
- Name string
- Name of the cookie.
- Path string
- Path to set for the cookie.
- Ttl
Region
Backend Service Strong Session Affinity Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- Name string
- Name of the cookie.
- Path string
- Path to set for the cookie.
- Ttl
Region
Backend Service Strong Session Affinity Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name String
- Name of the cookie.
- path String
- Path to set for the cookie.
- ttl
Region
Backend Service Strong Session Affinity Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name string
- Name of the cookie.
- path string
- Path to set for the cookie.
- ttl
Region
Backend Service Strong Session Affinity Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name str
- Name of the cookie.
- path str
- Path to set for the cookie.
- ttl
Region
Backend Service Strong Session Affinity Cookie Ttl - Lifetime of the cookie. Structure is documented below.
- name String
- Name of the cookie.
- path String
- Path to set for the cookie.
- ttl Property Map
- Lifetime of the cookie. Structure is documented below.
RegionBackendServiceStrongSessionAffinityCookieTtl, RegionBackendServiceStrongSessionAffinityCookieTtlArgs
, RegionBackendServiceStrongSessionAffinityCookieTtlArgs
- Seconds
This property is required. 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
This property is required. 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
This property is required. Integer - 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
This property is required. number - 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
This property is required. 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
This property is required. Number - 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.
RegionBackendServiceSubsetting, RegionBackendServiceSubsettingArgs
, RegionBackendServiceSubsettingArgs
- Policy
This property is required. string - The algorithm used for subsetting.
Possible values are:
CONSISTENT_HASH_SUBSETTING.
- Policy
This property is required. string - The algorithm used for subsetting.
Possible values are:
CONSISTENT_HASH_SUBSETTING.
- policy
This property is required. String - The algorithm used for subsetting.
Possible values are:
CONSISTENT_HASH_SUBSETTING.
- policy
This property is required. string - The algorithm used for subsetting.
Possible values are:
CONSISTENT_HASH_SUBSETTING.
- policy
This property is required. str - The algorithm used for subsetting.
Possible values are:
CONSISTENT_HASH_SUBSETTING.
- policy
This property is required. String - The algorithm used for subsetting.
Possible values are:
CONSISTENT_HASH_SUBSETTING.
Import
RegionBackendService can be imported using any of these accepted formats:
projects/{{project}}/regions/{{region}}/backendServices/{{name}}{{project}}/{{region}}/{{name}}{{region}}/{{name}}{{name}}
When using the pulumi import command, RegionBackendService can be imported using one of the formats above. For example:
$ pulumi import gcp:compute/regionBackendService:RegionBackendService default projects/{{project}}/regions/{{region}}/backendServices/{{name}}
$ pulumi import gcp:compute/regionBackendService:RegionBackendService default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:compute/regionBackendService:RegionBackendService default {{region}}/{{name}}
$ pulumi import gcp:compute/regionBackendService:RegionBackendService default {{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
- Example Usage
- Region Backend Service Basic
- Region Backend Service External Iap
- Region Backend Service Cache
- Region Backend Service Ilb Round Robin
- Region Backend Service External
- Region Backend Service External Weighted
- Region Backend Service Ilb Ring Hash
- Region Backend Service Ilb Stateful Session Affinity
- Region Backend Service Balancing Mode
- Region Backend Service Connection Tracking
- Region Backend Service Ip Address Selection Policy
- Region Backend Service Ilb Custom Metrics
- Create RegionBackendService Resource
- Constructor syntax
- Constructor example
- RegionBackendService Resource Properties
- Inputs
- Outputs
- Look up Existing RegionBackendService Resource
- Supporting Types
- Import
- Package Details