Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. RegionBackendService
Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi
pulumi/pulumi-gcp

gcp.compute.RegionBackendService

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi
pulumi/pulumi-gcp

    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:

    Warning: All arguments including the following potentially sensitive values will be stored in the raw state as plain text: iap.oauth2_client_secret, iap.oauth2_client_secret_sha256. Read more about sensitive data in state.

    Example Usage

    Region Backend Service Basic

    Coming soon!

    Coming soon!

    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()        
            .checkIntervalSec(1)
            .timeoutSec(1)
            .tcpHealthCheck(HealthCheckTcpHealthCheckArgs.builder()
                .port("80")
                .build())
            .build());

        var defaultRegionBackendService = new RegionBackendService("defaultRegionBackendService", RegionBackendServiceArgs.builder()        
            .region("us-central1")
            .healthChecks(defaultHealthCheck.id())
            .connectionDrainingTimeoutSec(10)
            .sessionAffinity("CLIENT_IP")
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  defaultRegionBackendService:
    type: gcp:compute:RegionBackendService
    properties:
      region: us-central1
      healthChecks:
        - ${defaultHealthCheck.id}
      connectionDrainingTimeoutSec: 10
      sessionAffinity: CLIENT_IP
  defaultHealthCheck:
    type: gcp:compute:HealthCheck
    properties:
      checkIntervalSec: 1
      timeoutSec: 1
      tcpHealthCheck:
        port: '80'

    Region Backend Service Cache

    Coming soon!

    Coming soon!

    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 com.pulumi.resources.CustomResourceOptions;
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()        
            .region("us-central1")
            .httpHealthCheck(RegionHealthCheckHttpHealthCheckArgs.builder()
                .port(80)
                .build())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var defaultRegionBackendService = new RegionBackendService("defaultRegionBackendService", RegionBackendServiceArgs.builder()        
            .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(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  defaultRegionBackendService:
    type: gcp:compute:RegionBackendService
    properties:
      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
    options:
      provider: ${["google-beta"]}
  defaultRegionHealthCheck:
    type: gcp:compute:RegionHealthCheck
    properties:
      region: us-central1
      httpHealthCheck:
        port: 80
    options:
      provider: ${["google-beta"]}

    Region Backend Service Ilb Round Robin

    Coming soon!

    Coming soon!

    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()        
            .httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
                .port(80)
                .build())
            .build());

        var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()        
            .region("us-central1")
            .healthChecks(healthCheck.id())
            .protocol("HTTP")
            .loadBalancingScheme("INTERNAL_MANAGED")
            .localityLbPolicy("ROUND_ROBIN")
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  default:
    type: gcp:compute:RegionBackendService
    properties:
      region: us-central1
      healthChecks:
        - ${healthCheck.id}
      protocol: HTTP
      loadBalancingScheme: INTERNAL_MANAGED
      localityLbPolicy: ROUND_ROBIN
  healthCheck:
    type: gcp:compute:HealthCheck
    properties:
      httpHealthCheck:
        port: 80

    Region Backend Service External

    Coming soon!

    Coming soon!

    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.resources.CustomResourceOptions;
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()        
            .region("us-central1")
            .tcpHealthCheck(RegionHealthCheckTcpHealthCheckArgs.builder()
                .port(80)
                .build())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()        
            .region("us-central1")
            .healthChecks(healthCheck.id())
            .protocol("TCP")
            .loadBalancingScheme("EXTERNAL")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  default:
    type: gcp:compute:RegionBackendService
    properties:
      region: us-central1
      healthChecks:
        - ${healthCheck.id}
      protocol: TCP
      loadBalancingScheme: EXTERNAL
    options:
      provider: ${["google-beta"]}
  healthCheck:
    type: gcp:compute:RegionHealthCheck
    properties:
      region: us-central1
      tcpHealthCheck:
        port: 80
    options:
      provider: ${["google-beta"]}

    Region Backend Service External Weighted

    Coming soon!

    Coming soon!

    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()        
            .region("us-central1")
            .httpHealthCheck(RegionHealthCheckHttpHealthCheckArgs.builder()
                .port(80)
                .build())
            .build());

        var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()        
            .region("us-central1")
            .healthChecks(healthCheck.id())
            .protocol("TCP")
            .loadBalancingScheme("EXTERNAL")
            .localityLbPolicy("WEIGHTED_MAGLEV")
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  default:
    type: gcp:compute:RegionBackendService
    properties:
      region: us-central1
      healthChecks:
        - ${healthCheck.id}
      protocol: TCP
      loadBalancingScheme: EXTERNAL
      localityLbPolicy: WEIGHTED_MAGLEV
  healthCheck:
    type: gcp:compute:RegionHealthCheck
    properties:
      region: us-central1
      httpHealthCheck:
        port: 80

    Region Backend Service Ilb Ring Hash

    Coming soon!

    Coming soon!

    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()        
            .httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
                .port(80)
                .build())
            .build());

        var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()        
            .region("us-central1")
            .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());

    }
}

    Coming soon!

    Coming soon!

    resources:
  default:
    type: gcp:compute:RegionBackendService
    properties:
      region: us-central1
      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
    properties:
      httpHealthCheck:
        port: 80

    Region Backend Service Balancing Mode

    Coming soon!

    Coming soon!

    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()        
            .autoCreateSubnetworks(false)
            .routingMode("REGIONAL")
            .build());

        var defaultSubnetwork = new Subnetwork("defaultSubnetwork", SubnetworkArgs.builder()        
            .ipCidrRange("10.1.2.0/24")
            .region("us-central1")
            .network(defaultNetwork.id())
            .build());

        var instanceTemplate = new InstanceTemplate("instanceTemplate", InstanceTemplateArgs.builder()        
            .machineType("e2-medium")
            .networkInterfaces(InstanceTemplateNetworkInterfaceArgs.builder()
                .network(defaultNetwork.id())
                .subnetwork(defaultSubnetwork.id())
                .build())
            .disks(InstanceTemplateDiskArgs.builder()
                .sourceImage(debianImage.applyValue(getImageResult -> getImageResult.selfLink()))
                .autoDelete(true)
                .boot(true)
                .build())
            .tags(            
                "allow-ssh",
                "load-balanced-backend")
            .build());

        var rigm = new RegionInstanceGroupManager("rigm", RegionInstanceGroupManagerArgs.builder()        
            .region("us-central1")
            .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")
            .httpHealthCheck(RegionHealthCheckHttpHealthCheckArgs.builder()
                .portSpecification("USE_SERVING_PORT")
                .build())
            .build());

        var defaultRegionBackendService = new RegionBackendService("defaultRegionBackendService", RegionBackendServiceArgs.builder()        
            .loadBalancingScheme("INTERNAL_MANAGED")
            .backends(RegionBackendServiceBackendArgs.builder()
                .group(rigm.instanceGroup())
                .balancingMode("UTILIZATION")
                .capacityScaler(1)
                .build())
            .region("us-central1")
            .protocol("HTTP")
            .timeoutSec(10)
            .healthChecks(defaultRegionHealthCheck.id())
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  defaultRegionBackendService:
    type: gcp:compute:RegionBackendService
    properties:
      loadBalancingScheme: INTERNAL_MANAGED
      backends:
        - group: ${rigm.instanceGroup}
          balancingMode: UTILIZATION
          capacityScaler: 1
      region: us-central1
      protocol: HTTP
      timeoutSec: 10
      healthChecks:
        - ${defaultRegionHealthCheck.id}
  rigm:
    type: gcp:compute:RegionInstanceGroupManager
    properties:
      region: us-central1
      versions:
        - instanceTemplate: ${instanceTemplate.id}
          name: primary
      baseInstanceName: internal-glb
      targetSize: 1
  instanceTemplate:
    type: gcp:compute:InstanceTemplate
    properties:
      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
    properties:
      region: us-central1
      httpHealthCheck:
        portSpecification: USE_SERVING_PORT
  defaultNetwork:
    type: gcp:compute:Network
    properties:
      autoCreateSubnetworks: false
      routingMode: REGIONAL
  defaultSubnetwork:
    type: gcp:compute:Subnetwork
    properties:
      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

    Coming soon!

    Coming soon!

    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 com.pulumi.resources.CustomResourceOptions;
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()        
            .region("us-central1")
            .tcpHealthCheck(RegionHealthCheckTcpHealthCheckArgs.builder()
                .port(22)
                .build())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

        var default_ = new RegionBackendService("default", RegionBackendServiceArgs.builder()        
            .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(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  default:
    type: gcp:compute:RegionBackendService
    properties:
      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
    options:
      provider: ${["google-beta"]}
  healthCheck:
    type: gcp:compute:RegionHealthCheck
    properties:
      region: us-central1
      tcpHealthCheck:
        port: 22
    options:
      provider: ${["google-beta"]}

    Create RegionBackendService Resource

    new RegionBackendService(name: string, args?: RegionBackendServiceArgs, opts?: CustomResourceOptions);
    @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,
                         description: Optional[str] = None,
                         enable_cdn: Optional[bool] = None,
                         failover_policy: Optional[RegionBackendServiceFailoverPolicyArgs] = None,
                         health_checks: Optional[str] = None,
                         iap: Optional[RegionBackendServiceIapArgs] = 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,
                         subsetting: Optional[RegionBackendServiceSubsettingArgs] = None,
                         timeout_sec: Optional[int] = None)
@overload
def RegionBackendService(resource_name: str,
                         args: Optional[RegionBackendServiceArgs] = None,
                         opts: Optional[ResourceOptions] = 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.
    name 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 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 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 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 String
    The unique name of the resource.
    args RegionBackendServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The RegionBackendService resource accepts the following input properties:

    AffinityCookieTtlSec 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<RegionBackendServiceBackend>

    The set of backends that serve this RegionBackendService. Structure is documented below.

    CdnPolicy RegionBackendServiceCdnPolicy

    Cloud CDN configuration for this BackendService. Structure is documented below.

    CircuitBreakers RegionBackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    ConnectionDrainingTimeoutSec int

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    ConnectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicy

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    ConsistentHash RegionBackendServiceConsistentHash

    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 -

    Description string

    An optional description of this resource.

    EnableCdn bool

    If true, enable Cloud CDN for this RegionBackendService.

    FailoverPolicy RegionBackendServiceFailoverPolicy

    Policy for failovers. Structure is documented below.

    HealthChecks 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 RegionBackendServiceIap

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    LoadBalancingScheme string

    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.

    LocalityLbPolicy string

    The load balancing algorithm used within the scope of the locality. The possible values are:

    LogConfig RegionBackendServiceLogConfig

    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 string

    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.

    OutlierDetection RegionBackendServiceOutlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    PortName 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 string

    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.

    SecurityPolicy string

    The security policy associated with this backend service.

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

    Subsetting RegionBackendServiceSubsetting

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    TimeoutSec int

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    AffinityCookieTtlSec 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 []RegionBackendServiceBackendArgs

    The set of backends that serve this RegionBackendService. Structure is documented below.

    CdnPolicy RegionBackendServiceCdnPolicyArgs

    Cloud CDN configuration for this BackendService. Structure is documented below.

    CircuitBreakers RegionBackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    ConnectionDrainingTimeoutSec int

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    ConnectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicyArgs

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    ConsistentHash RegionBackendServiceConsistentHashArgs

    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 -

    Description string

    An optional description of this resource.

    EnableCdn bool

    If true, enable Cloud CDN for this RegionBackendService.

    FailoverPolicy RegionBackendServiceFailoverPolicyArgs

    Policy for failovers. Structure is documented below.

    HealthChecks 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 RegionBackendServiceIapArgs

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    LoadBalancingScheme string

    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.

    LocalityLbPolicy string

    The load balancing algorithm used within the scope of the locality. The possible values are:

    LogConfig RegionBackendServiceLogConfigArgs

    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 string

    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.

    OutlierDetection RegionBackendServiceOutlierDetectionArgs

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    PortName 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 string

    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.

    SecurityPolicy string

    The security policy associated with this backend service.

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

    Subsetting RegionBackendServiceSubsettingArgs

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    TimeoutSec int

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    affinityCookieTtlSec 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<RegionBackendServiceBackend>

    The set of backends that serve this RegionBackendService. Structure is documented below.

    cdnPolicy RegionBackendServiceCdnPolicy

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuitBreakers RegionBackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connectionDrainingTimeoutSec Integer

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicy

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    consistentHash RegionBackendServiceConsistentHash

    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 -

    description String

    An optional description of this resource.

    enableCdn Boolean

    If true, enable Cloud CDN for this RegionBackendService.

    failoverPolicy RegionBackendServiceFailoverPolicy

    Policy for failovers. Structure is documented below.

    healthChecks 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 RegionBackendServiceIap

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    loadBalancingScheme String

    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.

    localityLbPolicy String

    The load balancing algorithm used within the scope of the locality. The possible values are:

    logConfig RegionBackendServiceLogConfig

    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 String

    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.

    outlierDetection RegionBackendServiceOutlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    portName 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 String

    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.

    securityPolicy String

    The security policy associated with this backend service.

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

    subsetting RegionBackendServiceSubsetting

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    timeoutSec Integer

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    affinityCookieTtlSec 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 RegionBackendServiceBackend[]

    The set of backends that serve this RegionBackendService. Structure is documented below.

    cdnPolicy RegionBackendServiceCdnPolicy

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuitBreakers RegionBackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connectionDrainingTimeoutSec number

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicy

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    consistentHash RegionBackendServiceConsistentHash

    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 -

    description string

    An optional description of this resource.

    enableCdn boolean

    If true, enable Cloud CDN for this RegionBackendService.

    failoverPolicy RegionBackendServiceFailoverPolicy

    Policy for failovers. Structure is documented below.

    healthChecks 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 RegionBackendServiceIap

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    loadBalancingScheme string

    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.

    localityLbPolicy string

    The load balancing algorithm used within the scope of the locality. The possible values are:

    logConfig RegionBackendServiceLogConfig

    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 string

    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.

    outlierDetection RegionBackendServiceOutlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    portName 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 string

    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.

    securityPolicy string

    The security policy associated with this backend service.

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

    subsetting RegionBackendServiceSubsetting

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    timeoutSec number

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    affinity_cookie_ttl_sec 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[RegionBackendServiceBackendArgs]

    The set of backends that serve this RegionBackendService. Structure is documented below.

    cdn_policy RegionBackendServiceCdnPolicyArgs

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuit_breakers RegionBackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connection_draining_timeout_sec int

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connection_tracking_policy RegionBackendServiceConnectionTrackingPolicyArgs

    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 RegionBackendServiceConsistentHashArgs

    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 -

    description str

    An optional description of this resource.

    enable_cdn bool

    If true, enable Cloud CDN for this RegionBackendService.

    failover_policy RegionBackendServiceFailoverPolicyArgs

    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 RegionBackendServiceIapArgs

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    load_balancing_scheme str

    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_policy str

    The load balancing algorithm used within the scope of the locality. The possible values are:

    log_config RegionBackendServiceLogConfigArgs

    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 str

    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 RegionBackendServiceOutlierDetectionArgs

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is 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 str

    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.

    subsetting RegionBackendServiceSubsettingArgs

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    timeout_sec int

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

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

    cdnPolicy Property Map

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuitBreakers Property Map

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connectionDrainingTimeoutSec Number

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connectionTrackingPolicy Property Map

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    consistentHash 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 -

    description String

    An optional description of this resource.

    enableCdn Boolean

    If true, enable Cloud CDN for this RegionBackendService.

    failoverPolicy Property Map

    Policy for failovers. Structure is documented below.

    healthChecks 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 Structure is documented below.

    loadBalancingScheme String

    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.

    localityLbPolicy String

    The load balancing algorithm used within the scope of the locality. The possible values are:

    logConfig 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 String

    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.

    outlierDetection Property Map

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    portName 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 String

    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.

    securityPolicy String

    The security policy associated with this backend service.

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

    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.

    timeoutSec Number

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RegionBackendService resource produces the following output properties:

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

    Id string

    The provider-assigned unique ID for this managed resource.

    SelfLink string

    The URI of the created resource.

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

    Id string

    The provider-assigned unique ID for this managed resource.

    SelfLink string

    The URI of the created resource.

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

    id String

    The provider-assigned unique ID for this managed resource.

    selfLink String

    The URI of the created resource.

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

    id string

    The provider-assigned unique ID for this managed resource.

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

    id str

    The provider-assigned unique ID for this managed resource.

    self_link str

    The URI of the created resource.

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

    id String

    The provider-assigned unique ID for this managed resource.

    selfLink 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,
        description: Optional[str] = None,
        enable_cdn: Optional[bool] = None,
        failover_policy: Optional[RegionBackendServiceFailoverPolicyArgs] = None,
        fingerprint: Optional[str] = None,
        health_checks: Optional[str] = None,
        iap: Optional[RegionBackendServiceIapArgs] = 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,
        subsetting: Optional[RegionBackendServiceSubsettingArgs] = None,
        timeout_sec: Optional[int] = None) -> RegionBackendService
    func 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AffinityCookieTtlSec 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<RegionBackendServiceBackend>

    The set of backends that serve this RegionBackendService. Structure is documented below.

    CdnPolicy RegionBackendServiceCdnPolicy

    Cloud CDN configuration for this BackendService. Structure is documented below.

    CircuitBreakers RegionBackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    ConnectionDrainingTimeoutSec int

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    ConnectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicy

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    ConsistentHash RegionBackendServiceConsistentHash

    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 -

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    Description string

    An optional description of this resource.

    EnableCdn bool

    If true, enable Cloud CDN for this RegionBackendService.

    FailoverPolicy RegionBackendServiceFailoverPolicy

    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.

    HealthChecks 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 RegionBackendServiceIap

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    LoadBalancingScheme string

    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.

    LocalityLbPolicy string

    The load balancing algorithm used within the scope of the locality. The possible values are:

    LogConfig RegionBackendServiceLogConfig

    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 string

    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.

    OutlierDetection RegionBackendServiceOutlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    PortName 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 string

    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.

    SecurityPolicy string

    The security policy associated with this backend service.

    SelfLink string

    The URI of the created resource.

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

    Subsetting RegionBackendServiceSubsetting

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    TimeoutSec int

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    AffinityCookieTtlSec 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 []RegionBackendServiceBackendArgs

    The set of backends that serve this RegionBackendService. Structure is documented below.

    CdnPolicy RegionBackendServiceCdnPolicyArgs

    Cloud CDN configuration for this BackendService. Structure is documented below.

    CircuitBreakers RegionBackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    ConnectionDrainingTimeoutSec int

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    ConnectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicyArgs

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    ConsistentHash RegionBackendServiceConsistentHashArgs

    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 -

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    Description string

    An optional description of this resource.

    EnableCdn bool

    If true, enable Cloud CDN for this RegionBackendService.

    FailoverPolicy RegionBackendServiceFailoverPolicyArgs

    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.

    HealthChecks 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 RegionBackendServiceIapArgs

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    LoadBalancingScheme string

    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.

    LocalityLbPolicy string

    The load balancing algorithm used within the scope of the locality. The possible values are:

    LogConfig RegionBackendServiceLogConfigArgs

    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 string

    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.

    OutlierDetection RegionBackendServiceOutlierDetectionArgs

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    PortName 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 string

    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.

    SecurityPolicy string

    The security policy associated with this backend service.

    SelfLink string

    The URI of the created resource.

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

    Subsetting RegionBackendServiceSubsettingArgs

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    TimeoutSec int

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    affinityCookieTtlSec 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<RegionBackendServiceBackend>

    The set of backends that serve this RegionBackendService. Structure is documented below.

    cdnPolicy RegionBackendServiceCdnPolicy

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuitBreakers RegionBackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connectionDrainingTimeoutSec Integer

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicy

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    consistentHash RegionBackendServiceConsistentHash

    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 -

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    description String

    An optional description of this resource.

    enableCdn Boolean

    If true, enable Cloud CDN for this RegionBackendService.

    failoverPolicy RegionBackendServiceFailoverPolicy

    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.

    healthChecks 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 RegionBackendServiceIap

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    loadBalancingScheme String

    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.

    localityLbPolicy String

    The load balancing algorithm used within the scope of the locality. The possible values are:

    logConfig RegionBackendServiceLogConfig

    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 String

    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.

    outlierDetection RegionBackendServiceOutlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    portName 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 String

    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.

    securityPolicy String

    The security policy associated with this backend service.

    selfLink String

    The URI of the created resource.

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

    subsetting RegionBackendServiceSubsetting

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    timeoutSec Integer

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    affinityCookieTtlSec 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 RegionBackendServiceBackend[]

    The set of backends that serve this RegionBackendService. Structure is documented below.

    cdnPolicy RegionBackendServiceCdnPolicy

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuitBreakers RegionBackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connectionDrainingTimeoutSec number

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connectionTrackingPolicy RegionBackendServiceConnectionTrackingPolicy

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    consistentHash RegionBackendServiceConsistentHash

    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 -

    creationTimestamp string

    Creation timestamp in RFC3339 text format.

    description string

    An optional description of this resource.

    enableCdn boolean

    If true, enable Cloud CDN for this RegionBackendService.

    failoverPolicy RegionBackendServiceFailoverPolicy

    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.

    healthChecks 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 RegionBackendServiceIap

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    loadBalancingScheme string

    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.

    localityLbPolicy string

    The load balancing algorithm used within the scope of the locality. The possible values are:

    logConfig RegionBackendServiceLogConfig

    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 string

    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.

    outlierDetection RegionBackendServiceOutlierDetection

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    portName 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 string

    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.

    securityPolicy string

    The security policy associated with this backend service.

    selfLink string

    The URI of the created resource.

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

    subsetting RegionBackendServiceSubsetting

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    timeoutSec number

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    affinity_cookie_ttl_sec 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[RegionBackendServiceBackendArgs]

    The set of backends that serve this RegionBackendService. Structure is documented below.

    cdn_policy RegionBackendServiceCdnPolicyArgs

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuit_breakers RegionBackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connection_draining_timeout_sec int

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connection_tracking_policy RegionBackendServiceConnectionTrackingPolicyArgs

    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 RegionBackendServiceConsistentHashArgs

    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.

    description str

    An optional description of this resource.

    enable_cdn bool

    If true, enable Cloud CDN for this RegionBackendService.

    failover_policy RegionBackendServiceFailoverPolicyArgs

    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.

    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 RegionBackendServiceIapArgs

    Settings for enabling Cloud Identity Aware Proxy Structure is documented below.

    load_balancing_scheme str

    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_policy str

    The load balancing algorithm used within the scope of the locality. The possible values are:

    log_config RegionBackendServiceLogConfigArgs

    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 str

    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 RegionBackendServiceOutlierDetectionArgs

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is 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 str

    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.

    subsetting RegionBackendServiceSubsettingArgs

    Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing and Internal HTTP(S) load balancing.

    timeout_sec int

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

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

    cdnPolicy Property Map

    Cloud CDN configuration for this BackendService. Structure is documented below.

    circuitBreakers Property Map

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    connectionDrainingTimeoutSec Number

    Time for which instance will be drained (not accept new connections, but still work to finish started).

    connectionTrackingPolicy Property Map

    Connection Tracking configuration for this BackendService. This is available only for Layer 4 Internal Load Balancing and Network Load Balancing. Structure is documented below.

    consistentHash 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 -

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    description String

    An optional description of this resource.

    enableCdn Boolean

    If true, enable Cloud CDN for this RegionBackendService.

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

    healthChecks 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 Structure is documented below.

    loadBalancingScheme String

    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.

    localityLbPolicy String

    The load balancing algorithm used within the scope of the locality. The possible values are:

    logConfig 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 String

    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.

    outlierDetection Property Map

    Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable only when the load_balancing_scheme is set to INTERNAL_MANAGED and the protocol is set to HTTP, HTTPS, or HTTP2. Structure is documented below.

    portName 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 String

    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.

    securityPolicy String

    The security policy associated with this backend service.

    selfLink String

    The URI of the created resource.

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

    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.

    timeoutSec Number

    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].

    Supporting Types

    RegionBackendServiceBackend, RegionBackendServiceBackendArgs

    Group string

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

    BalancingMode string

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

    CapacityScaler double

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

    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.

    MaxConnections int

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

    MaxConnectionsPerEndpoint int

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

    MaxConnectionsPerInstance int

    The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. 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.

    MaxRate int

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

    MaxRatePerEndpoint double

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

    MaxRatePerInstance double

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

    MaxUtilization double

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

    Group string

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

    BalancingMode string

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

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

    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.

    MaxConnections int

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

    MaxConnectionsPerEndpoint int

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

    MaxConnectionsPerInstance int

    The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. 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.

    MaxRate int

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

    MaxRatePerEndpoint float64

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

    MaxRatePerInstance float64

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

    MaxUtilization 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 String

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

    balancingMode String

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

    capacityScaler Double

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

    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.

    maxConnections Integer

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

    maxConnectionsPerEndpoint Integer

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

    maxConnectionsPerInstance Integer

    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.

    maxRate Integer

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

    maxRatePerEndpoint Double

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

    maxRatePerInstance Double

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

    maxUtilization Double

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

    group string

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

    balancingMode string

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

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

    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.

    maxConnections number

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

    maxConnectionsPerEndpoint number

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

    maxConnectionsPerInstance number

    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.

    maxRate number

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

    maxRatePerEndpoint number

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

    maxRatePerInstance number

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

    maxUtilization 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 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_scheme is INTERNAL, only instance groups are supported. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

    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 CONNECTION. Possible values are: UTILIZATION, RATE, CONNECTION.

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

    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_per_endpoint int

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

    max_connections_per_instance int

    The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. 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_per_endpoint float

    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_per_instance float

    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 String

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

    balancingMode String

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

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

    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.

    maxConnections Number

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

    maxConnectionsPerEndpoint Number

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

    maxConnectionsPerInstance Number

    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.

    maxRate Number

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

    maxRatePerEndpoint Number

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

    maxRatePerInstance Number

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

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

    RegionBackendServiceCdnPolicy, RegionBackendServiceCdnPolicyArgs

    CacheKeyPolicy RegionBackendServiceCdnPolicyCacheKeyPolicy

    The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

    CacheMode string

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

    ClientTtl int

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

    DefaultTtl int

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

    MaxTtl int

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

    NegativeCaching bool

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

    NegativeCachingPolicies List<RegionBackendServiceCdnPolicyNegativeCachingPolicy>

    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.

    ServeWhileStale int

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

    SignedUrlCacheMaxAgeSec int

    Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

    CacheKeyPolicy RegionBackendServiceCdnPolicyCacheKeyPolicy

    The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

    CacheMode string

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

    ClientTtl int

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

    DefaultTtl int

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

    MaxTtl int

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

    NegativeCaching bool

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

    NegativeCachingPolicies []RegionBackendServiceCdnPolicyNegativeCachingPolicy

    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.

    ServeWhileStale int

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

    SignedUrlCacheMaxAgeSec int

    Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

    cacheKeyPolicy RegionBackendServiceCdnPolicyCacheKeyPolicy

    The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

    cacheMode String

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

    clientTtl Integer

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

    defaultTtl Integer

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

    maxTtl Integer

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

    negativeCaching Boolean

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

    negativeCachingPolicies List<RegionBackendServiceCdnPolicyNegativeCachingPolicy>

    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.

    serveWhileStale Integer

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

    signedUrlCacheMaxAgeSec Integer

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

    cacheKeyPolicy RegionBackendServiceCdnPolicyCacheKeyPolicy

    The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

    cacheMode string

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

    clientTtl number

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

    defaultTtl number

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

    maxTtl number

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

    negativeCaching boolean

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

    negativeCachingPolicies RegionBackendServiceCdnPolicyNegativeCachingPolicy[]

    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.

    serveWhileStale number

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

    signedUrlCacheMaxAgeSec number

    Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served. 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_policy RegionBackendServiceCdnPolicyCacheKeyPolicy

    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_policies Sequence[RegionBackendServiceCdnPolicyNegativeCachingPolicy]

    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_stale int

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

    signed_url_cache_max_age_sec int

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

    cacheKeyPolicy Property Map

    The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

    cacheMode String

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

    clientTtl Number

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

    defaultTtl Number

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

    maxTtl Number

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

    negativeCaching Boolean

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

    negativeCachingPolicies List<Property Map>

    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.

    serveWhileStale Number

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

    signedUrlCacheMaxAgeSec Number

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

    IncludeHost bool

    If true requests to different hosts will be cached separately.

    IncludeNamedCookies List<string>

    Names of cookies to include in cache keys.

    IncludeProtocol bool

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

    IncludeQueryString bool

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

    QueryStringBlacklists List<string>

    Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    QueryStringWhitelists List<string>

    Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    IncludeHost bool

    If true requests to different hosts will be cached separately.

    IncludeNamedCookies []string

    Names of cookies to include in cache keys.

    IncludeProtocol bool

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

    IncludeQueryString bool

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

    QueryStringBlacklists []string

    Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    QueryStringWhitelists []string

    Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    includeHost Boolean

    If true requests to different hosts will be cached separately.

    includeNamedCookies List<String>

    Names of cookies to include in cache keys.

    includeProtocol Boolean

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

    includeQueryString Boolean

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

    queryStringBlacklists List<String>

    Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    queryStringWhitelists List<String>

    Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    includeHost boolean

    If true requests to different hosts will be cached separately.

    includeNamedCookies string[]

    Names of cookies to include in cache keys.

    includeProtocol boolean

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

    includeQueryString boolean

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

    queryStringBlacklists string[]

    Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    queryStringWhitelists string[]

    Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    include_host bool

    If true requests to different hosts will be cached separately.

    include_named_cookies Sequence[str]

    Names of cookies to include in cache keys.

    include_protocol bool

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

    include_query_string bool

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

    query_string_blacklists Sequence[str]

    Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    query_string_whitelists Sequence[str]

    Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    includeHost Boolean

    If true requests to different hosts will be cached separately.

    includeNamedCookies List<String>

    Names of cookies to include in cache keys.

    includeProtocol Boolean

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

    includeQueryString Boolean

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

    queryStringBlacklists List<String>

    Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    queryStringWhitelists List<String>

    Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

    RegionBackendServiceCdnPolicyNegativeCachingPolicy, 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

    ConnectTimeout RegionBackendServiceCircuitBreakersConnectTimeout

    The timeout for new network connections to hosts. Structure is documented below.

    MaxConnections int

    The maximum number of connections to the backend cluster. Defaults to 1024.

    MaxPendingRequests int

    The maximum number of pending requests to the backend cluster. Defaults to 1024.

    MaxRequests int

    The maximum number of parallel requests to the backend cluster. Defaults to 1024.

    MaxRequestsPerConnection int

    Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

    MaxRetries int

    The maximum number of parallel retries to the backend cluster. Defaults to 3.

    ConnectTimeout RegionBackendServiceCircuitBreakersConnectTimeout

    The timeout for new network connections to hosts. Structure is documented below.

    MaxConnections int

    The maximum number of connections to the backend cluster. Defaults to 1024.

    MaxPendingRequests int

    The maximum number of pending requests to the backend cluster. Defaults to 1024.

    MaxRequests int

    The maximum number of parallel requests to the backend cluster. Defaults to 1024.

    MaxRequestsPerConnection int

    Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

    MaxRetries int

    The maximum number of parallel retries to the backend cluster. Defaults to 3.

    connectTimeout RegionBackendServiceCircuitBreakersConnectTimeout

    The timeout for new network connections to hosts. Structure is documented below.

    maxConnections Integer

    The maximum number of connections to the backend cluster. Defaults to 1024.

    maxPendingRequests Integer

    The maximum number of pending requests to the backend cluster. Defaults to 1024.

    maxRequests Integer

    The maximum number of parallel requests to the backend cluster. Defaults to 1024.

    maxRequestsPerConnection Integer

    Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

    maxRetries Integer

    The maximum number of parallel retries to the backend cluster. Defaults to 3.

    connectTimeout RegionBackendServiceCircuitBreakersConnectTimeout

    The timeout for new network connections to hosts. Structure is documented below.

    maxConnections number

    The maximum number of connections to the backend cluster. Defaults to 1024.

    maxPendingRequests number

    The maximum number of pending requests to the backend cluster. Defaults to 1024.

    maxRequests number

    The maximum number of parallel requests to the backend cluster. Defaults to 1024.

    maxRequestsPerConnection number

    Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

    maxRetries number

    The maximum number of parallel retries to the backend cluster. Defaults to 3.

    connect_timeout RegionBackendServiceCircuitBreakersConnectTimeout

    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_requests int

    The maximum number of pending requests to the backend cluster. Defaults to 1024.

    max_requests int

    The maximum number of parallel requests to the backend cluster. Defaults to 1024.

    max_requests_per_connection int

    Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

    max_retries int

    The maximum number of parallel retries to the backend cluster. Defaults to 3.

    connectTimeout Property Map

    The timeout for new network connections to hosts. Structure is documented below.

    maxConnections Number

    The maximum number of connections to the backend cluster. Defaults to 1024.

    maxPendingRequests Number

    The maximum number of pending requests to the backend cluster. Defaults to 1024.

    maxRequests Number

    The maximum number of parallel requests to the backend cluster. Defaults to 1024.

    maxRequestsPerConnection Number

    Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

    maxRetries Number

    The maximum number of parallel retries to the backend cluster. Defaults to 3.

    RegionBackendServiceCircuitBreakersConnectTimeout, RegionBackendServiceCircuitBreakersConnectTimeoutArgs

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

    Nanos int

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

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

    Nanos 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 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 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 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 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

    ConnectionPersistenceOnUnhealthyBackends string

    Specifies connection persistence when backends are unhealthy. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value is DEFAULT_FOR_PROTOCOL. Possible values are: DEFAULT_FOR_PROTOCOL, NEVER_PERSIST, ALWAYS_PERSIST.

    EnableStrongAffinity bool

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

    IdleTimeoutSec int

    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours. For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

    TrackingMode string

    Specifies the key used for connection tracking. There are two options: PER_CONNECTION: The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. Default value is PER_CONNECTION. Possible values are: PER_CONNECTION, PER_SESSION.

    ConnectionPersistenceOnUnhealthyBackends string

    Specifies connection persistence when backends are unhealthy. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value is DEFAULT_FOR_PROTOCOL. Possible values are: DEFAULT_FOR_PROTOCOL, NEVER_PERSIST, ALWAYS_PERSIST.

    EnableStrongAffinity bool

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

    IdleTimeoutSec int

    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours. For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

    TrackingMode string

    Specifies the key used for connection tracking. There are two options: PER_CONNECTION: The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. Default value is PER_CONNECTION. Possible values are: PER_CONNECTION, PER_SESSION.

    connectionPersistenceOnUnhealthyBackends String

    Specifies connection persistence when backends are unhealthy. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value is DEFAULT_FOR_PROTOCOL. Possible values are: DEFAULT_FOR_PROTOCOL, NEVER_PERSIST, ALWAYS_PERSIST.

    enableStrongAffinity Boolean

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

    idleTimeoutSec Integer

    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours. For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

    trackingMode String

    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 is PER_CONNECTION. Possible values are: PER_CONNECTION, PER_SESSION.

    connectionPersistenceOnUnhealthyBackends string

    Specifies connection persistence when backends are unhealthy. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value is DEFAULT_FOR_PROTOCOL. Possible values are: DEFAULT_FOR_PROTOCOL, NEVER_PERSIST, ALWAYS_PERSIST.

    enableStrongAffinity boolean

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

    idleTimeoutSec number

    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours. For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

    trackingMode string

    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 is PER_CONNECTION. Possible values are: PER_CONNECTION, PER_SESSION.

    connection_persistence_on_unhealthy_backends str

    Specifies connection persistence when backends are unhealthy. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value is DEFAULT_FOR_PROTOCOL. Possible values are: DEFAULT_FOR_PROTOCOL, NEVER_PERSIST, ALWAYS_PERSIST.

    enable_strong_affinity bool

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

    idle_timeout_sec int

    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours. For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

    tracking_mode str

    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 is PER_CONNECTION. Possible values are: PER_CONNECTION, PER_SESSION.

    connectionPersistenceOnUnhealthyBackends String

    Specifies connection persistence when backends are unhealthy. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. Default value is DEFAULT_FOR_PROTOCOL. Possible values are: DEFAULT_FOR_PROTOCOL, NEVER_PERSIST, ALWAYS_PERSIST.

    enableStrongAffinity Boolean

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

    idleTimeoutSec Number

    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For L4 ILB the minimum(default) is 10 minutes and maximum is 16 hours. For NLB the minimum(default) is 60 seconds and the maximum is 16 hours.

    trackingMode String

    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 is PER_CONNECTION. Possible values are: PER_CONNECTION, PER_SESSION.

    RegionBackendServiceConsistentHash, RegionBackendServiceConsistentHashArgs

    HttpCookie RegionBackendServiceConsistentHashHttpCookie

    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.

    HttpHeaderName string

    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

    MinimumRingSize int

    The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

    HttpCookie RegionBackendServiceConsistentHashHttpCookie

    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.

    HttpHeaderName string

    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

    MinimumRingSize int

    The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

    httpCookie RegionBackendServiceConsistentHashHttpCookie

    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.

    httpHeaderName String

    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

    minimumRingSize Integer

    The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

    httpCookie RegionBackendServiceConsistentHashHttpCookie

    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.

    httpHeaderName string

    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

    minimumRingSize number

    The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

    http_cookie RegionBackendServiceConsistentHashHttpCookie

    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_name str

    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

    minimum_ring_size int

    The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

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

    httpHeaderName String

    The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

    minimumRingSize Number

    The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

    RegionBackendServiceConsistentHashHttpCookie, RegionBackendServiceConsistentHashHttpCookieArgs

    Name string

    Name of the cookie.

    Path string

    Path to set for the cookie.

    Ttl RegionBackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    Name string

    Name of the cookie.

    Path string

    Path to set for the cookie.

    Ttl RegionBackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    name String

    Name of the cookie.

    path String

    Path to set for the cookie.

    ttl RegionBackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    name string

    Name of the cookie.

    path string

    Path to set for the cookie.

    ttl RegionBackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    name str

    Name of the cookie.

    path str

    Path to set for the cookie.

    ttl RegionBackendServiceConsistentHashHttpCookieTtl

    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

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

    Nanos int

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

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

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

    RegionBackendServiceFailoverPolicy, RegionBackendServiceFailoverPolicyArgs

    DisableConnectionDrainOnFailover bool

    On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

    DropTrafficIfUnhealthy bool

    This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

    FailoverRatio double

    The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

    DisableConnectionDrainOnFailover bool

    On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

    DropTrafficIfUnhealthy bool

    This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

    FailoverRatio float64

    The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

    disableConnectionDrainOnFailover Boolean

    On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

    dropTrafficIfUnhealthy Boolean

    This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

    failoverRatio Double

    The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

    disableConnectionDrainOnFailover boolean

    On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

    dropTrafficIfUnhealthy boolean

    This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

    failoverRatio number

    The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

    disable_connection_drain_on_failover bool

    On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

    drop_traffic_if_unhealthy bool

    This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

    failover_ratio float

    The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

    disableConnectionDrainOnFailover Boolean

    On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

    dropTrafficIfUnhealthy Boolean

    This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

    failoverRatio Number

    The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

    RegionBackendServiceIap, RegionBackendServiceIapArgs

    Oauth2ClientId string

    OAuth2 Client ID for IAP

    Oauth2ClientSecret string

    OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.

    Oauth2ClientSecretSha256 string

    (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.

    Oauth2ClientId string

    OAuth2 Client ID for IAP

    Oauth2ClientSecret string

    OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.

    Oauth2ClientSecretSha256 string

    (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2ClientId String

    OAuth2 Client ID for IAP

    oauth2ClientSecret String

    OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2ClientSecretSha256 String

    (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2ClientId string

    OAuth2 Client ID for IAP

    oauth2ClientSecret string

    OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2ClientSecretSha256 string

    (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2_client_id str

    OAuth2 Client ID for IAP

    oauth2_client_secret str

    OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2_client_secret_sha256 str

    (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2ClientId String

    OAuth2 Client ID for IAP

    oauth2ClientSecret String

    OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.

    oauth2ClientSecretSha256 String

    (Output) OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.

    RegionBackendServiceLogConfig, RegionBackendServiceLogConfigArgs

    Enable bool

    Whether to enable logging for the load balancer traffic served by this backend service.

    SampleRate double

    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

    Enable bool

    Whether to enable logging for the load balancer traffic served by this backend service.

    SampleRate float64

    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

    enable Boolean

    Whether to enable logging for the load balancer traffic served by this backend service.

    sampleRate Double

    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

    enable boolean

    Whether to enable logging for the load balancer traffic served by this backend service.

    sampleRate number

    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

    enable bool

    Whether to enable logging for the load balancer traffic served by this backend service.

    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.

    sampleRate Number

    This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

    RegionBackendServiceOutlierDetection, RegionBackendServiceOutlierDetectionArgs

    BaseEjectionTime RegionBackendServiceOutlierDetectionBaseEjectionTime

    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.

    ConsecutiveErrors int

    Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

    ConsecutiveGatewayFailure int

    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

    EnforcingConsecutiveErrors int

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    EnforcingConsecutiveGatewayFailure int

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

    EnforcingSuccessRate int

    The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    Interval RegionBackendServiceOutlierDetectionInterval

    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.

    MaxEjectionPercent int

    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

    SuccessRateMinimumHosts int

    The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

    SuccessRateRequestVolume int

    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

    SuccessRateStdevFactor int

    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

    BaseEjectionTime RegionBackendServiceOutlierDetectionBaseEjectionTime

    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.

    ConsecutiveErrors int

    Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

    ConsecutiveGatewayFailure int

    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

    EnforcingConsecutiveErrors int

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    EnforcingConsecutiveGatewayFailure int

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

    EnforcingSuccessRate int

    The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    Interval RegionBackendServiceOutlierDetectionInterval

    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.

    MaxEjectionPercent int

    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

    SuccessRateMinimumHosts int

    The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

    SuccessRateRequestVolume int

    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

    SuccessRateStdevFactor int

    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

    baseEjectionTime RegionBackendServiceOutlierDetectionBaseEjectionTime

    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.

    consecutiveErrors Integer

    Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

    consecutiveGatewayFailure Integer

    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

    enforcingConsecutiveErrors Integer

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    enforcingConsecutiveGatewayFailure Integer

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

    enforcingSuccessRate Integer

    The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    interval RegionBackendServiceOutlierDetectionInterval

    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.

    maxEjectionPercent Integer

    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

    successRateMinimumHosts Integer

    The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

    successRateRequestVolume Integer

    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

    successRateStdevFactor Integer

    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

    baseEjectionTime RegionBackendServiceOutlierDetectionBaseEjectionTime

    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.

    consecutiveErrors number

    Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

    consecutiveGatewayFailure number

    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

    enforcingConsecutiveErrors number

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    enforcingConsecutiveGatewayFailure number

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

    enforcingSuccessRate number

    The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    interval RegionBackendServiceOutlierDetectionInterval

    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.

    maxEjectionPercent number

    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

    successRateMinimumHosts number

    The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

    successRateRequestVolume number

    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

    successRateStdevFactor number

    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

    base_ejection_time RegionBackendServiceOutlierDetectionBaseEjectionTime

    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_failure int

    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

    enforcing_consecutive_errors int

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    enforcing_consecutive_gateway_failure int

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

    enforcing_success_rate int

    The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    interval RegionBackendServiceOutlierDetectionInterval

    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_percent int

    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

    success_rate_minimum_hosts int

    The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

    success_rate_request_volume int

    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

    success_rate_stdev_factor int

    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

    baseEjectionTime Property Map

    The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. Structure is documented below.

    consecutiveErrors Number

    Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

    consecutiveGatewayFailure Number

    The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

    enforcingConsecutiveErrors Number

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    enforcingConsecutiveGatewayFailure Number

    The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

    enforcingSuccessRate Number

    The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

    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.

    maxEjectionPercent Number

    Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

    successRateMinimumHosts Number

    The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

    successRateRequestVolume Number

    The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

    successRateStdevFactor Number

    This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

    RegionBackendServiceOutlierDetectionBaseEjectionTime, RegionBackendServiceOutlierDetectionBaseEjectionTimeArgs

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

    Nanos int

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

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

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

    RegionBackendServiceOutlierDetectionInterval, RegionBackendServiceOutlierDetectionIntervalArgs

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

    Nanos int

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

    Seconds int

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

    Nanos 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 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 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 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 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

    Policy string

    The algorithm used for subsetting. Possible values are: CONSISTENT_HASH_SUBSETTING.

    Policy string

    The algorithm used for subsetting. Possible values are: CONSISTENT_HASH_SUBSETTING.

    policy String

    The algorithm used for subsetting. Possible values are: CONSISTENT_HASH_SUBSETTING.

    policy string

    The algorithm used for subsetting. Possible values are: CONSISTENT_HASH_SUBSETTING.

    policy str

    The algorithm used for subsetting. Possible values are: CONSISTENT_HASH_SUBSETTING.

    policy 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}} In Terraform v1.5.0 and later, use an import block to import RegionBackendService using one of the formats above. For exampletf import {

    id = “projects/{{project}}/regions/{{region}}/backendServices/{{name}}”

    to = google_compute_region_backend_service.default }

     $ pulumi import gcp:compute/regionBackendService:RegionBackendService When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), 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}}

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi
    pulumi/pulumi-gcp