1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. BackendService
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi

gcp.compute.BackendService

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi

    A Backend Service defines a group of virtual machines that will serve traffic for load balancing. This resource is a global backend service, appropriate for external load balancing or self-managed internal load balancing. For managed internal load balancing, use a regional backend service instead.

    Currently self-managed internal load balancing is only available in beta.

    To get more information about BackendService, see:

    Warning: All arguments including iap.oauth2_client_secret and iap.oauth2_client_secret_sha256 will be stored in the raw state as plain-text.

    Example Usage

    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.HttpHealthCheck;
    import com.pulumi.gcp.compute.HttpHealthCheckArgs;
    import com.pulumi.gcp.compute.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder()        
                .requestPath("/")
                .checkIntervalSec(1)
                .timeoutSec(1)
                .build());
    
            var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder()        
                .healthChecks(defaultHttpHealthCheck.id())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      defaultBackendService:
        type: gcp:compute:BackendService
        properties:
          healthChecks:
            - ${defaultHttpHealthCheck.id}
      defaultHttpHealthCheck:
        type: gcp:compute:HttpHealthCheck
        properties:
          requestPath: /
          checkIntervalSec: 1
          timeoutSec: 1
    

    Backend Service Cache Simple

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Gcp.Compute.BackendService("default", new()
        {
            CdnPolicy = new Gcp.Compute.Inputs.BackendServiceCdnPolicyArgs
            {
                CacheKeyPolicy = new Gcp.Compute.Inputs.BackendServiceCdnPolicyCacheKeyPolicyArgs
                {
                    IncludeHost = true,
                    IncludeHttpHeaders = new[]
                    {
                        "X-My-Header-Field",
                    },
                    IncludeProtocol = true,
                    IncludeQueryString = true,
                },
                CacheMode = "USE_ORIGIN_HEADERS",
            },
            EnableCdn = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := compute.NewBackendService(ctx, "default", &compute.BackendServiceArgs{
    			CdnPolicy: &compute.BackendServiceCdnPolicyArgs{
    				CacheKeyPolicy: &compute.BackendServiceCdnPolicyCacheKeyPolicyArgs{
    					IncludeHost: pulumi.Bool(true),
    					IncludeHttpHeaders: pulumi.StringArray{
    						pulumi.String("X-My-Header-Field"),
    					},
    					IncludeProtocol:    pulumi.Bool(true),
    					IncludeQueryString: pulumi.Bool(true),
    				},
    				CacheMode: pulumi.String("USE_ORIGIN_HEADERS"),
    			},
    			EnableCdn: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.HttpHealthCheck;
    import com.pulumi.gcp.compute.HttpHealthCheckArgs;
    import com.pulumi.gcp.compute.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCdnPolicyArgs;
    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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder()        
                .requestPath("/")
                .checkIntervalSec(1)
                .timeoutSec(1)
                .build());
    
            var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder()        
                .healthChecks(defaultHttpHealthCheck.id())
                .enableCdn(true)
                .cdnPolicy(BackendServiceCdnPolicyArgs.builder()
                    .signedUrlCacheMaxAgeSec(7200)
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    default = gcp.compute.BackendService("default",
        cdn_policy=gcp.compute.BackendServiceCdnPolicyArgs(
            cache_key_policy=gcp.compute.BackendServiceCdnPolicyCacheKeyPolicyArgs(
                include_host=True,
                include_http_headers=["X-My-Header-Field"],
                include_protocol=True,
                include_query_string=True,
            ),
            cache_mode="USE_ORIGIN_HEADERS",
        ),
        enable_cdn=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const _default = new gcp.compute.BackendService("default", {
        cdnPolicy: {
            cacheKeyPolicy: {
                includeHost: true,
                includeHttpHeaders: ["X-My-Header-Field"],
                includeProtocol: true,
                includeQueryString: true,
            },
            cacheMode: "USE_ORIGIN_HEADERS",
        },
        enableCdn: true,
    });
    
    resources:
      defaultBackendService:
        type: gcp:compute:BackendService
        properties:
          healthChecks:
            - ${defaultHttpHealthCheck.id}
          enableCdn: true
          cdnPolicy:
            signedUrlCacheMaxAgeSec: 7200
      defaultHttpHealthCheck:
        type: gcp:compute:HttpHealthCheck
        properties:
          requestPath: /
          checkIntervalSec: 1
          timeoutSec: 1
    

    Backend Service Cache Include Http Headers

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Gcp.Compute.BackendService("default", new()
        {
            CdnPolicy = new Gcp.Compute.Inputs.BackendServiceCdnPolicyArgs
            {
                CacheKeyPolicy = new Gcp.Compute.Inputs.BackendServiceCdnPolicyCacheKeyPolicyArgs
                {
                    IncludeHost = true,
                    IncludeNamedCookies = new[]
                    {
                        "__next_preview_data",
                        "__prerender_bypass",
                    },
                    IncludeProtocol = true,
                    IncludeQueryString = true,
                },
                CacheMode = "CACHE_ALL_STATIC",
                ClientTtl = 7200,
                DefaultTtl = 3600,
                MaxTtl = 10800,
            },
            EnableCdn = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := compute.NewBackendService(ctx, "default", &compute.BackendServiceArgs{
    			CdnPolicy: &compute.BackendServiceCdnPolicyArgs{
    				CacheKeyPolicy: &compute.BackendServiceCdnPolicyCacheKeyPolicyArgs{
    					IncludeHost: pulumi.Bool(true),
    					IncludeNamedCookies: pulumi.StringArray{
    						pulumi.String("__next_preview_data"),
    						pulumi.String("__prerender_bypass"),
    					},
    					IncludeProtocol:    pulumi.Bool(true),
    					IncludeQueryString: pulumi.Bool(true),
    				},
    				CacheMode:  pulumi.String("CACHE_ALL_STATIC"),
    				ClientTtl:  pulumi.Int(7200),
    				DefaultTtl: pulumi.Int(3600),
    				MaxTtl:     pulumi.Int(10800),
    			},
    			EnableCdn: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCdnPolicyArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCdnPolicyCacheKeyPolicyArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var default_ = new BackendService("default", BackendServiceArgs.builder()        
                .cdnPolicy(BackendServiceCdnPolicyArgs.builder()
                    .cacheKeyPolicy(BackendServiceCdnPolicyCacheKeyPolicyArgs.builder()
                        .includeHost(true)
                        .includeHttpHeaders("X-My-Header-Field")
                        .includeProtocol(true)
                        .includeQueryString(true)
                        .build())
                    .cacheMode("USE_ORIGIN_HEADERS")
                    .build())
                .enableCdn(true)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    default = gcp.compute.BackendService("default",
        cdn_policy=gcp.compute.BackendServiceCdnPolicyArgs(
            cache_key_policy=gcp.compute.BackendServiceCdnPolicyCacheKeyPolicyArgs(
                include_host=True,
                include_named_cookies=[
                    "__next_preview_data",
                    "__prerender_bypass",
                ],
                include_protocol=True,
                include_query_string=True,
            ),
            cache_mode="CACHE_ALL_STATIC",
            client_ttl=7200,
            default_ttl=3600,
            max_ttl=10800,
        ),
        enable_cdn=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const _default = new gcp.compute.BackendService("default", {
        cdnPolicy: {
            cacheKeyPolicy: {
                includeHost: true,
                includeNamedCookies: [
                    "__next_preview_data",
                    "__prerender_bypass",
                ],
                includeProtocol: true,
                includeQueryString: true,
            },
            cacheMode: "CACHE_ALL_STATIC",
            clientTtl: 7200,
            defaultTtl: 3600,
            maxTtl: 10800,
        },
        enableCdn: true,
    });
    
    resources:
      default:
        type: gcp:compute:BackendService
        properties:
          cdnPolicy:
            cacheKeyPolicy:
              includeHost: true
              includeHttpHeaders:
                - X-My-Header-Field
              includeProtocol: true
              includeQueryString: true
            cacheMode: USE_ORIGIN_HEADERS
          enableCdn: true
    

    Backend Service Cache Include Named Cookies

    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.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCdnPolicyArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCdnPolicyCacheKeyPolicyArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var default_ = new BackendService("default", BackendServiceArgs.builder()        
                .cdnPolicy(BackendServiceCdnPolicyArgs.builder()
                    .cacheKeyPolicy(BackendServiceCdnPolicyCacheKeyPolicyArgs.builder()
                        .includeHost(true)
                        .includeNamedCookies(                    
                            "__next_preview_data",
                            "__prerender_bypass")
                        .includeProtocol(true)
                        .includeQueryString(true)
                        .build())
                    .cacheMode("CACHE_ALL_STATIC")
                    .clientTtl(7200)
                    .defaultTtl(3600)
                    .maxTtl(10800)
                    .build())
                .enableCdn(true)
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      default:
        type: gcp:compute:BackendService
        properties:
          cdnPolicy:
            cacheKeyPolicy:
              includeHost: true
              includeNamedCookies:
                - __next_preview_data
                - __prerender_bypass
              includeProtocol: true
              includeQueryString: true
            cacheMode: CACHE_ALL_STATIC
            clientTtl: 7200
            defaultTtl: 3600
            maxTtl: 10800
          enableCdn: true
    

    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.HttpHealthCheck;
    import com.pulumi.gcp.compute.HttpHealthCheckArgs;
    import com.pulumi.gcp.compute.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCdnPolicyArgs;
    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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder()        
                .requestPath("/")
                .checkIntervalSec(1)
                .timeoutSec(1)
                .build());
    
            var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder()        
                .healthChecks(defaultHttpHealthCheck.id())
                .enableCdn(true)
                .cdnPolicy(BackendServiceCdnPolicyArgs.builder()
                    .cacheMode("CACHE_ALL_STATIC")
                    .defaultTtl(3600)
                    .clientTtl(7200)
                    .maxTtl(10800)
                    .negativeCaching(true)
                    .signedUrlCacheMaxAgeSec(7200)
                    .build())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      defaultBackendService:
        type: gcp:compute:BackendService
        properties:
          healthChecks:
            - ${defaultHttpHealthCheck.id}
          enableCdn: true
          cdnPolicy:
            cacheMode: CACHE_ALL_STATIC
            defaultTtl: 3600
            clientTtl: 7200
            maxTtl: 10800
            negativeCaching: true
            signedUrlCacheMaxAgeSec: 7200
      defaultHttpHealthCheck:
        type: gcp:compute:HttpHealthCheck
        properties:
          requestPath: /
          checkIntervalSec: 1
          timeoutSec: 1
    

    Backend Service Cache Bypass Cache On Request Headers

    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.HttpHealthCheck;
    import com.pulumi.gcp.compute.HttpHealthCheckArgs;
    import com.pulumi.gcp.compute.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCdnPolicyArgs;
    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 defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder()        
                .requestPath("/")
                .checkIntervalSec(1)
                .timeoutSec(1)
                .build());
    
            var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder()        
                .healthChecks(defaultHttpHealthCheck.id())
                .enableCdn(true)
                .cdnPolicy(BackendServiceCdnPolicyArgs.builder()
                    .cacheMode("CACHE_ALL_STATIC")
                    .defaultTtl(3600)
                    .clientTtl(7200)
                    .maxTtl(10800)
                    .negativeCaching(true)
                    .signedUrlCacheMaxAgeSec(7200)
                    .bypassCacheOnRequestHeaders(                
                        BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs.builder()
                            .headerName("Authorization")
                            .build(),
                        BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs.builder()
                            .headerName("Proxy-Authorization")
                            .build())
                    .build())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      defaultBackendService:
        type: gcp:compute:BackendService
        properties:
          healthChecks:
            - ${defaultHttpHealthCheck.id}
          enableCdn: true
          cdnPolicy:
            cacheMode: CACHE_ALL_STATIC
            defaultTtl: 3600
            clientTtl: 7200
            maxTtl: 10800
            negativeCaching: true
            signedUrlCacheMaxAgeSec: 7200
            bypassCacheOnRequestHeaders:
              - headerName: Authorization
              - headerName: Proxy-Authorization
      defaultHttpHealthCheck:
        type: gcp:compute:HttpHealthCheck
        properties:
          requestPath: /
          checkIntervalSec: 1
          timeoutSec: 1
    

    Backend Service Traffic Director 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.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    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 HealthCheck("healthCheck", HealthCheckArgs.builder()        
                .httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
                    .port(80)
                    .build())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var default_ = new BackendService("default", BackendServiceArgs.builder()        
                .healthChecks(healthCheck.id())
                .loadBalancingScheme("INTERNAL_SELF_MANAGED")
                .localityLbPolicy("ROUND_ROBIN")
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      default:
        type: gcp:compute:BackendService
        properties:
          healthChecks:
            - ${healthCheck.id}
          loadBalancingScheme: INTERNAL_SELF_MANAGED
          localityLbPolicy: ROUND_ROBIN
        options:
          provider: ${["google-beta"]}
      healthCheck:
        type: gcp:compute:HealthCheck
        properties:
          httpHealthCheck:
            port: 80
        options:
          provider: ${["google-beta"]}
    

    Backend Service Traffic Director Ring Hash

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var externalProxy = new Gcp.Compute.GlobalNetworkEndpointGroup("externalProxy", new()
        {
            NetworkEndpointType = "INTERNET_FQDN_PORT",
            DefaultPort = 443,
        }, new CustomResourceOptions
        {
            Provider = google_beta,
        });
    
        var proxy = new Gcp.Compute.GlobalNetworkEndpoint("proxy", new()
        {
            GlobalNetworkEndpointGroup = externalProxy.Id,
            Fqdn = "test.example.com",
            Port = externalProxy.DefaultPort,
        }, new CustomResourceOptions
        {
            Provider = google_beta,
        });
    
        var @default = new Gcp.Compute.BackendService("default", new()
        {
            EnableCdn = true,
            TimeoutSec = 10,
            ConnectionDrainingTimeoutSec = 10,
            CustomRequestHeaders = new[]
            {
                proxy.Fqdn.Apply(fqdn => $"host: {fqdn}"),
            },
            CustomResponseHeaders = new[]
            {
                "X-Cache-Hit: {cdn_cache_status}",
            },
            Backends = new[]
            {
                new Gcp.Compute.Inputs.BackendServiceBackendArgs
                {
                    Group = externalProxy.Id,
                },
            },
        }, new CustomResourceOptions
        {
            Provider = google_beta,
        });
    
    });
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		externalProxy, err := compute.NewGlobalNetworkEndpointGroup(ctx, "externalProxy", &compute.GlobalNetworkEndpointGroupArgs{
    			NetworkEndpointType: pulumi.String("INTERNET_FQDN_PORT"),
    			DefaultPort:         pulumi.Int(443),
    		}, pulumi.Provider(google_beta))
    		if err != nil {
    			return err
    		}
    		proxy, err := compute.NewGlobalNetworkEndpoint(ctx, "proxy", &compute.GlobalNetworkEndpointArgs{
    			GlobalNetworkEndpointGroup: externalProxy.ID(),
    			Fqdn:                       pulumi.String("test.example.com"),
    			Port:                       externalProxy.DefaultPort,
    		}, pulumi.Provider(google_beta))
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewBackendService(ctx, "default", &compute.BackendServiceArgs{
    			EnableCdn:                    pulumi.Bool(true),
    			TimeoutSec:                   pulumi.Int(10),
    			ConnectionDrainingTimeoutSec: pulumi.Int(10),
    			CustomRequestHeaders: pulumi.StringArray{
    				proxy.Fqdn.ApplyT(func(fqdn *string) (string, error) {
    					return fmt.Sprintf("host: %v", fqdn), nil
    				}).(pulumi.StringOutput),
    			},
    			CustomResponseHeaders: pulumi.StringArray{
    				pulumi.String("X-Cache-Hit: {cdn_cache_status}"),
    			},
    			Backends: compute.BackendServiceBackendArray{
    				&compute.BackendServiceBackendArgs{
    					Group: externalProxy.ID(),
    				},
    			},
    		}, pulumi.Provider(google_beta))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceCircuitBreakersArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceConsistentHashArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceConsistentHashHttpCookieArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceConsistentHashHttpCookieTtlArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceOutlierDetectionArgs;
    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 HealthCheck("healthCheck", HealthCheckArgs.builder()        
                .httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
                    .port(80)
                    .build())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var default_ = new BackendService("default", BackendServiceArgs.builder()        
                .healthChecks(healthCheck.id())
                .loadBalancingScheme("INTERNAL_SELF_MANAGED")
                .localityLbPolicy("RING_HASH")
                .sessionAffinity("HTTP_COOKIE")
                .circuitBreakers(BackendServiceCircuitBreakersArgs.builder()
                    .maxConnections(10)
                    .build())
                .consistentHash(BackendServiceConsistentHashArgs.builder()
                    .httpCookie(BackendServiceConsistentHashHttpCookieArgs.builder()
                        .ttl(BackendServiceConsistentHashHttpCookieTtlArgs.builder()
                            .seconds(11)
                            .nanos(1111)
                            .build())
                        .name("mycookie")
                        .build())
                    .build())
                .outlierDetection(BackendServiceOutlierDetectionArgs.builder()
                    .consecutiveErrors(2)
                    .build())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    external_proxy = gcp.compute.GlobalNetworkEndpointGroup("externalProxy",
        network_endpoint_type="INTERNET_FQDN_PORT",
        default_port=443,
        opts=pulumi.ResourceOptions(provider=google_beta))
    proxy = gcp.compute.GlobalNetworkEndpoint("proxy",
        global_network_endpoint_group=external_proxy.id,
        fqdn="test.example.com",
        port=external_proxy.default_port,
        opts=pulumi.ResourceOptions(provider=google_beta))
    default = gcp.compute.BackendService("default",
        enable_cdn=True,
        timeout_sec=10,
        connection_draining_timeout_sec=10,
        custom_request_headers=[proxy.fqdn.apply(lambda fqdn: f"host: {fqdn}")],
        custom_response_headers=["X-Cache-Hit: {cdn_cache_status}"],
        backends=[gcp.compute.BackendServiceBackendArgs(
            group=external_proxy.id,
        )],
        opts=pulumi.ResourceOptions(provider=google_beta))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const externalProxy = new gcp.compute.GlobalNetworkEndpointGroup("externalProxy", {
        networkEndpointType: "INTERNET_FQDN_PORT",
        defaultPort: 443,
    }, {
        provider: google_beta,
    });
    const proxy = new gcp.compute.GlobalNetworkEndpoint("proxy", {
        globalNetworkEndpointGroup: externalProxy.id,
        fqdn: "test.example.com",
        port: externalProxy.defaultPort,
    }, {
        provider: google_beta,
    });
    const _default = new gcp.compute.BackendService("default", {
        enableCdn: true,
        timeoutSec: 10,
        connectionDrainingTimeoutSec: 10,
        customRequestHeaders: [proxy.fqdn.apply(fqdn => `host: ${fqdn}`)],
        customResponseHeaders: ["X-Cache-Hit: {cdn_cache_status}"],
        backends: [{
            group: externalProxy.id,
        }],
    }, {
        provider: google_beta,
    });
    
    resources:
      default:
        type: gcp:compute:BackendService
        properties:
          healthChecks:
            - ${healthCheck.id}
          loadBalancingScheme: INTERNAL_SELF_MANAGED
          localityLbPolicy: RING_HASH
          sessionAffinity: HTTP_COOKIE
          circuitBreakers:
            maxConnections: 10
          consistentHash:
            httpCookie:
              ttl:
                seconds: 11
                nanos: 1111
              name: mycookie
          outlierDetection:
            consecutiveErrors: 2
        options:
          provider: ${["google-beta"]}
      healthCheck:
        type: gcp:compute:HealthCheck
        properties:
          httpHealthCheck:
            port: 80
        options:
          provider: ${["google-beta"]}
    

    Backend Service Network Endpoint

    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.GlobalNetworkEndpointGroup;
    import com.pulumi.gcp.compute.GlobalNetworkEndpointGroupArgs;
    import com.pulumi.gcp.compute.GlobalNetworkEndpoint;
    import com.pulumi.gcp.compute.GlobalNetworkEndpointArgs;
    import com.pulumi.gcp.compute.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    import com.pulumi.gcp.compute.inputs.BackendServiceBackendArgs;
    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 externalProxy = new GlobalNetworkEndpointGroup("externalProxy", GlobalNetworkEndpointGroupArgs.builder()        
                .networkEndpointType("INTERNET_FQDN_PORT")
                .defaultPort("443")
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var proxy = new GlobalNetworkEndpoint("proxy", GlobalNetworkEndpointArgs.builder()        
                .globalNetworkEndpointGroup(externalProxy.id())
                .fqdn("test.example.com")
                .port(externalProxy.defaultPort())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var default_ = new BackendService("default", BackendServiceArgs.builder()        
                .enableCdn(true)
                .timeoutSec(10)
                .connectionDrainingTimeoutSec(10)
                .customRequestHeaders(proxy.fqdn().applyValue(fqdn -> String.format("host: %s", fqdn)))
                .customResponseHeaders("X-Cache-Hit: {cdn_cache_status}")
                .backends(BackendServiceBackendArgs.builder()
                    .group(externalProxy.id())
                    .build())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      externalProxy:
        type: gcp:compute:GlobalNetworkEndpointGroup
        properties:
          networkEndpointType: INTERNET_FQDN_PORT
          defaultPort: '443'
        options:
          provider: ${["google-beta"]}
      proxy:
        type: gcp:compute:GlobalNetworkEndpoint
        properties:
          globalNetworkEndpointGroup: ${externalProxy.id}
          fqdn: test.example.com
          port: ${externalProxy.defaultPort}
        options:
          provider: ${["google-beta"]}
      default:
        type: gcp:compute:BackendService
        properties:
          enableCdn: true
          timeoutSec: 10
          connectionDrainingTimeoutSec: 10
          customRequestHeaders:
            - 'host: ${proxy.fqdn}'
          customResponseHeaders:
            - 'X-Cache-Hit: {cdn_cache_status}'
          backends:
            - group: ${externalProxy.id}
        options:
          provider: ${["google-beta"]}
    

    Backend Service External Managed

    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.BackendService;
    import com.pulumi.gcp.compute.BackendServiceArgs;
    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()        
                .httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
                    .port(80)
                    .build())
                .build());
    
            var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder()        
                .healthChecks(defaultHealthCheck.id())
                .loadBalancingScheme("EXTERNAL_MANAGED")
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      defaultBackendService:
        type: gcp:compute:BackendService
        properties:
          healthChecks:
            - ${defaultHealthCheck.id}
          loadBalancingScheme: EXTERNAL_MANAGED
      defaultHealthCheck:
        type: gcp:compute:HealthCheck
        properties:
          httpHealthCheck:
            port: 80
    

    Create BackendService Resource

    new BackendService(name: string, args?: BackendServiceArgs, opts?: CustomResourceOptions);
    @overload
    def BackendService(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       affinity_cookie_ttl_sec: Optional[int] = None,
                       backends: Optional[Sequence[BackendServiceBackendArgs]] = None,
                       cdn_policy: Optional[BackendServiceCdnPolicyArgs] = None,
                       circuit_breakers: Optional[BackendServiceCircuitBreakersArgs] = None,
                       compression_mode: Optional[str] = None,
                       connection_draining_timeout_sec: Optional[int] = None,
                       consistent_hash: Optional[BackendServiceConsistentHashArgs] = None,
                       custom_request_headers: Optional[Sequence[str]] = None,
                       custom_response_headers: Optional[Sequence[str]] = None,
                       description: Optional[str] = None,
                       edge_security_policy: Optional[str] = None,
                       enable_cdn: Optional[bool] = None,
                       health_checks: Optional[str] = None,
                       iap: Optional[BackendServiceIapArgs] = None,
                       load_balancing_scheme: Optional[str] = None,
                       locality_lb_policies: Optional[Sequence[BackendServiceLocalityLbPolicyArgs]] = None,
                       locality_lb_policy: Optional[str] = None,
                       log_config: Optional[BackendServiceLogConfigArgs] = None,
                       name: Optional[str] = None,
                       outlier_detection: Optional[BackendServiceOutlierDetectionArgs] = None,
                       port_name: Optional[str] = None,
                       project: Optional[str] = None,
                       protocol: Optional[str] = None,
                       security_policy: Optional[str] = None,
                       security_settings: Optional[BackendServiceSecuritySettingsArgs] = None,
                       session_affinity: Optional[str] = None,
                       timeout_sec: Optional[int] = None)
    @overload
    def BackendService(resource_name: str,
                       args: Optional[BackendServiceArgs] = None,
                       opts: Optional[ResourceOptions] = None)
    func NewBackendService(ctx *Context, name string, args *BackendServiceArgs, opts ...ResourceOption) (*BackendService, error)
    public BackendService(string name, BackendServiceArgs? args = null, CustomResourceOptions? opts = null)
    public BackendService(String name, BackendServiceArgs args)
    public BackendService(String name, BackendServiceArgs args, CustomResourceOptions options)
    
    type: gcp:compute:BackendService
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args BackendServiceArgs
    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 BackendServiceArgs
    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 BackendServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackendServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackendServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    BackendService 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 BackendService 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<BackendServiceBackend>

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

    CdnPolicy BackendServiceCdnPolicy

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

    CircuitBreakers BackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    CompressionMode string

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    ConnectionDrainingTimeoutSec int

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

    ConsistentHash BackendServiceConsistentHash

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    CustomRequestHeaders List<string>

    Headers that the HTTP/S load balancer should add to proxied requests.

    CustomResponseHeaders List<string>

    Headers that the HTTP/S load balancer should add to proxied responses.

    Description string

    An optional description of this resource.

    EdgeSecurityPolicy string

    The resource URL for the edge security policy associated with this backend service.

    EnableCdn bool

    If true, enable Cloud CDN for this BackendService.

    HealthChecks string

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    Iap BackendServiceIap

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

    LoadBalancingScheme string

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    LocalityLbPolicies List<BackendServiceLocalityLbPolicy>

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    LocalityLbPolicy string

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

    LogConfig BackendServiceLogConfig

    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.


    OutlierDetection BackendServiceOutlierDetection

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

    PortName string

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    SecurityPolicy string

    The security policy associated with this backend service.

    SecuritySettings BackendServiceSecuritySettings

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

    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 []BackendServiceBackendArgs

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

    CdnPolicy BackendServiceCdnPolicyArgs

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

    CircuitBreakers BackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    CompressionMode string

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    ConnectionDrainingTimeoutSec int

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

    ConsistentHash BackendServiceConsistentHashArgs

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    CustomRequestHeaders []string

    Headers that the HTTP/S load balancer should add to proxied requests.

    CustomResponseHeaders []string

    Headers that the HTTP/S load balancer should add to proxied responses.

    Description string

    An optional description of this resource.

    EdgeSecurityPolicy string

    The resource URL for the edge security policy associated with this backend service.

    EnableCdn bool

    If true, enable Cloud CDN for this BackendService.

    HealthChecks string

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    Iap BackendServiceIapArgs

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

    LoadBalancingScheme string

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    LocalityLbPolicies []BackendServiceLocalityLbPolicyArgs

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    LocalityLbPolicy string

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

    LogConfig BackendServiceLogConfigArgs

    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.


    OutlierDetection BackendServiceOutlierDetectionArgs

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

    PortName string

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    SecurityPolicy string

    The security policy associated with this backend service.

    SecuritySettings BackendServiceSecuritySettingsArgs

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

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

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

    cdnPolicy BackendServiceCdnPolicy

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

    circuitBreakers BackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    compressionMode String

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connectionDrainingTimeoutSec Integer

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

    consistentHash BackendServiceConsistentHash

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    customRequestHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied requests.

    customResponseHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied responses.

    description String

    An optional description of this resource.

    edgeSecurityPolicy String

    The resource URL for the edge security policy associated with this backend service.

    enableCdn Boolean

    If true, enable Cloud CDN for this BackendService.

    healthChecks String

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap BackendServiceIap

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

    loadBalancingScheme String

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    localityLbPolicies List<BackendServiceLocalityLbPolicy>

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    localityLbPolicy String

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

    logConfig BackendServiceLogConfig

    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.


    outlierDetection BackendServiceOutlierDetection

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

    portName String

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    securityPolicy String

    The security policy associated with this backend service.

    securitySettings BackendServiceSecuritySettings

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

    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 BackendServiceBackend[]

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

    cdnPolicy BackendServiceCdnPolicy

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

    circuitBreakers BackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    compressionMode string

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connectionDrainingTimeoutSec number

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

    consistentHash BackendServiceConsistentHash

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    customRequestHeaders string[]

    Headers that the HTTP/S load balancer should add to proxied requests.

    customResponseHeaders string[]

    Headers that the HTTP/S load balancer should add to proxied responses.

    description string

    An optional description of this resource.

    edgeSecurityPolicy string

    The resource URL for the edge security policy associated with this backend service.

    enableCdn boolean

    If true, enable Cloud CDN for this BackendService.

    healthChecks string

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap BackendServiceIap

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

    loadBalancingScheme string

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    localityLbPolicies BackendServiceLocalityLbPolicy[]

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    localityLbPolicy string

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

    logConfig BackendServiceLogConfig

    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.


    outlierDetection BackendServiceOutlierDetection

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

    portName string

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    securityPolicy string

    The security policy associated with this backend service.

    securitySettings BackendServiceSecuritySettings

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

    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[BackendServiceBackendArgs]

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

    cdn_policy BackendServiceCdnPolicyArgs

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

    circuit_breakers BackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    compression_mode str

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connection_draining_timeout_sec int

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

    consistent_hash BackendServiceConsistentHashArgs

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    custom_request_headers Sequence[str]

    Headers that the HTTP/S load balancer should add to proxied requests.

    custom_response_headers Sequence[str]

    Headers that the HTTP/S load balancer should add to proxied responses.

    description str

    An optional description of this resource.

    edge_security_policy str

    The resource URL for the edge security policy associated with this backend service.

    enable_cdn bool

    If true, enable Cloud CDN for this BackendService.

    health_checks str

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap BackendServiceIapArgs

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

    load_balancing_scheme str

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    locality_lb_policies Sequence[BackendServiceLocalityLbPolicyArgs]

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    locality_lb_policy str

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

    log_config BackendServiceLogConfigArgs

    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.


    outlier_detection BackendServiceOutlierDetectionArgs

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

    port_name str

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    security_policy str

    The security policy associated with this backend service.

    security_settings BackendServiceSecuritySettingsArgs

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

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

    compressionMode String

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connectionDrainingTimeoutSec Number

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

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    customRequestHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied requests.

    customResponseHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied responses.

    description String

    An optional description of this resource.

    edgeSecurityPolicy String

    The resource URL for the edge security policy associated with this backend service.

    enableCdn Boolean

    If true, enable Cloud CDN for this BackendService.

    healthChecks String

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap Property Map

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

    loadBalancingScheme String

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    localityLbPolicies List<Property Map>

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    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.


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

    portName String

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    securityPolicy String

    The security policy associated with this backend service.

    securitySettings Property Map

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

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

    GeneratedId int

    The unique identifier for the resource. This identifier is defined by the server.

    Id string

    The provider-assigned unique ID for this managed resource.

    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.

    GeneratedId int

    The unique identifier for the resource. This identifier is defined by the server.

    Id string

    The provider-assigned unique ID for this managed resource.

    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.

    generatedId Integer

    The unique identifier for the resource. This identifier is defined by the server.

    id String

    The provider-assigned unique ID for this managed resource.

    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.

    generatedId number

    The unique identifier for the resource. This identifier is defined by the server.

    id string

    The provider-assigned unique ID for this managed resource.

    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.

    generated_id int

    The unique identifier for the resource. This identifier is defined by the server.

    id str

    The provider-assigned unique ID for this managed resource.

    self_link str

    The URI of the created resource.

    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.

    generatedId Number

    The unique identifier for the resource. This identifier is defined by the server.

    id String

    The provider-assigned unique ID for this managed resource.

    selfLink String

    The URI of the created resource.

    Look up Existing BackendService Resource

    Get an existing BackendService 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?: BackendServiceState, opts?: CustomResourceOptions): BackendService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            affinity_cookie_ttl_sec: Optional[int] = None,
            backends: Optional[Sequence[BackendServiceBackendArgs]] = None,
            cdn_policy: Optional[BackendServiceCdnPolicyArgs] = None,
            circuit_breakers: Optional[BackendServiceCircuitBreakersArgs] = None,
            compression_mode: Optional[str] = None,
            connection_draining_timeout_sec: Optional[int] = None,
            consistent_hash: Optional[BackendServiceConsistentHashArgs] = None,
            creation_timestamp: Optional[str] = None,
            custom_request_headers: Optional[Sequence[str]] = None,
            custom_response_headers: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            edge_security_policy: Optional[str] = None,
            enable_cdn: Optional[bool] = None,
            fingerprint: Optional[str] = None,
            generated_id: Optional[int] = None,
            health_checks: Optional[str] = None,
            iap: Optional[BackendServiceIapArgs] = None,
            load_balancing_scheme: Optional[str] = None,
            locality_lb_policies: Optional[Sequence[BackendServiceLocalityLbPolicyArgs]] = None,
            locality_lb_policy: Optional[str] = None,
            log_config: Optional[BackendServiceLogConfigArgs] = None,
            name: Optional[str] = None,
            outlier_detection: Optional[BackendServiceOutlierDetectionArgs] = None,
            port_name: Optional[str] = None,
            project: Optional[str] = None,
            protocol: Optional[str] = None,
            security_policy: Optional[str] = None,
            security_settings: Optional[BackendServiceSecuritySettingsArgs] = None,
            self_link: Optional[str] = None,
            session_affinity: Optional[str] = None,
            timeout_sec: Optional[int] = None) -> BackendService
    func GetBackendService(ctx *Context, name string, id IDInput, state *BackendServiceState, opts ...ResourceOption) (*BackendService, error)
    public static BackendService Get(string name, Input<string> id, BackendServiceState? state, CustomResourceOptions? opts = null)
    public static BackendService get(String name, Output<String> id, BackendServiceState 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<BackendServiceBackend>

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

    CdnPolicy BackendServiceCdnPolicy

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

    CircuitBreakers BackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    CompressionMode string

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    ConnectionDrainingTimeoutSec int

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

    ConsistentHash BackendServiceConsistentHash

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    CustomRequestHeaders List<string>

    Headers that the HTTP/S load balancer should add to proxied requests.

    CustomResponseHeaders List<string>

    Headers that the HTTP/S load balancer should add to proxied responses.

    Description string

    An optional description of this resource.

    EdgeSecurityPolicy string

    The resource URL for the edge security policy associated with this backend service.

    EnableCdn bool

    If true, enable Cloud CDN for this BackendService.

    Fingerprint string

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

    GeneratedId int

    The unique identifier for the resource. This identifier is defined by the server.

    HealthChecks string

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    Iap BackendServiceIap

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

    LoadBalancingScheme string

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    LocalityLbPolicies List<BackendServiceLocalityLbPolicy>

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    LocalityLbPolicy string

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

    LogConfig BackendServiceLogConfig

    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.


    OutlierDetection BackendServiceOutlierDetection

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

    PortName string

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    SecurityPolicy string

    The security policy associated with this backend service.

    SecuritySettings BackendServiceSecuritySettings

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

    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 []BackendServiceBackendArgs

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

    CdnPolicy BackendServiceCdnPolicyArgs

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

    CircuitBreakers BackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    CompressionMode string

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    ConnectionDrainingTimeoutSec int

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

    ConsistentHash BackendServiceConsistentHashArgs

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    CustomRequestHeaders []string

    Headers that the HTTP/S load balancer should add to proxied requests.

    CustomResponseHeaders []string

    Headers that the HTTP/S load balancer should add to proxied responses.

    Description string

    An optional description of this resource.

    EdgeSecurityPolicy string

    The resource URL for the edge security policy associated with this backend service.

    EnableCdn bool

    If true, enable Cloud CDN for this BackendService.

    Fingerprint string

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

    GeneratedId int

    The unique identifier for the resource. This identifier is defined by the server.

    HealthChecks string

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    Iap BackendServiceIapArgs

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

    LoadBalancingScheme string

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    LocalityLbPolicies []BackendServiceLocalityLbPolicyArgs

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    LocalityLbPolicy string

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

    LogConfig BackendServiceLogConfigArgs

    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.


    OutlierDetection BackendServiceOutlierDetectionArgs

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

    PortName string

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    SecurityPolicy string

    The security policy associated with this backend service.

    SecuritySettings BackendServiceSecuritySettingsArgs

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

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

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

    cdnPolicy BackendServiceCdnPolicy

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

    circuitBreakers BackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    compressionMode String

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connectionDrainingTimeoutSec Integer

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

    consistentHash BackendServiceConsistentHash

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    customRequestHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied requests.

    customResponseHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied responses.

    description String

    An optional description of this resource.

    edgeSecurityPolicy String

    The resource URL for the edge security policy associated with this backend service.

    enableCdn Boolean

    If true, enable Cloud CDN for this BackendService.

    fingerprint String

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

    generatedId Integer

    The unique identifier for the resource. This identifier is defined by the server.

    healthChecks String

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap BackendServiceIap

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

    loadBalancingScheme String

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    localityLbPolicies List<BackendServiceLocalityLbPolicy>

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    localityLbPolicy String

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

    logConfig BackendServiceLogConfig

    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.


    outlierDetection BackendServiceOutlierDetection

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

    portName String

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    securityPolicy String

    The security policy associated with this backend service.

    securitySettings BackendServiceSecuritySettings

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

    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 BackendServiceBackend[]

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

    cdnPolicy BackendServiceCdnPolicy

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

    circuitBreakers BackendServiceCircuitBreakers

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    compressionMode string

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connectionDrainingTimeoutSec number

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

    consistentHash BackendServiceConsistentHash

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    creationTimestamp string

    Creation timestamp in RFC3339 text format.

    customRequestHeaders string[]

    Headers that the HTTP/S load balancer should add to proxied requests.

    customResponseHeaders string[]

    Headers that the HTTP/S load balancer should add to proxied responses.

    description string

    An optional description of this resource.

    edgeSecurityPolicy string

    The resource URL for the edge security policy associated with this backend service.

    enableCdn boolean

    If true, enable Cloud CDN for this BackendService.

    fingerprint string

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

    generatedId number

    The unique identifier for the resource. This identifier is defined by the server.

    healthChecks string

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap BackendServiceIap

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

    loadBalancingScheme string

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    localityLbPolicies BackendServiceLocalityLbPolicy[]

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    localityLbPolicy string

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

    logConfig BackendServiceLogConfig

    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.


    outlierDetection BackendServiceOutlierDetection

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

    portName string

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    securityPolicy string

    The security policy associated with this backend service.

    securitySettings BackendServiceSecuritySettings

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

    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[BackendServiceBackendArgs]

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

    cdn_policy BackendServiceCdnPolicyArgs

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

    circuit_breakers BackendServiceCircuitBreakersArgs

    Settings controlling the volume of connections to a backend service. This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. Structure is documented below.

    compression_mode str

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connection_draining_timeout_sec int

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

    consistent_hash BackendServiceConsistentHashArgs

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    creation_timestamp str

    Creation timestamp in RFC3339 text format.

    custom_request_headers Sequence[str]

    Headers that the HTTP/S load balancer should add to proxied requests.

    custom_response_headers Sequence[str]

    Headers that the HTTP/S load balancer should add to proxied responses.

    description str

    An optional description of this resource.

    edge_security_policy str

    The resource URL for the edge security policy associated with this backend service.

    enable_cdn bool

    If true, enable Cloud CDN for this BackendService.

    fingerprint str

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

    generated_id int

    The unique identifier for the resource. This identifier is defined by the server.

    health_checks str

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap BackendServiceIapArgs

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

    load_balancing_scheme str

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    locality_lb_policies Sequence[BackendServiceLocalityLbPolicyArgs]

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    locality_lb_policy str

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

    log_config BackendServiceLogConfigArgs

    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.


    outlier_detection BackendServiceOutlierDetectionArgs

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

    port_name str

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    security_policy str

    The security policy associated with this backend service.

    security_settings BackendServiceSecuritySettingsArgs

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

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

    compressionMode String

    Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values are: AUTOMATIC, DISABLED.

    connectionDrainingTimeoutSec Number

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

    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 if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH. Structure is documented below.

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    customRequestHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied requests.

    customResponseHeaders List<String>

    Headers that the HTTP/S load balancer should add to proxied responses.

    description String

    An optional description of this resource.

    edgeSecurityPolicy String

    The resource URL for the edge security policy associated with this backend service.

    enableCdn Boolean

    If true, enable Cloud CDN for this BackendService.

    fingerprint String

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

    generatedId Number

    The unique identifier for the resource. This identifier is defined by the server.

    healthChecks String

    The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. 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. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

    iap Property Map

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

    loadBalancingScheme String

    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. For more information, refer to Choosing a load balancer. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, EXTERNAL_MANAGED.

    localityLbPolicies List<Property Map>

    A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true. Structure is documented below.

    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.


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

    portName String

    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

    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 BackendService 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. NOTE: With protocol “UNSPECIFIED”, the backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing with TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values are: HTTP, HTTPS, HTTP2, TCP, SSL, GRPC, UNSPECIFIED.

    securityPolicy String

    The security policy associated with this backend service.

    securitySettings Property Map

    The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

    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.

    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

    BackendServiceBackend, BackendServiceBackendArgs

    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. 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. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). See the Backend Services Overview for an explanation of load balancing modes. Default value is UTILIZATION. Possible values are: UTILIZATION, RATE, CONNECTION.

    CapacityScaler double

    A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). 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.

    MaxConnections int

    The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. 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. 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. 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. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For 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.

    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.

    MaxUtilization double

    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

    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. 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. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). See the Backend Services Overview for an explanation of load balancing modes. Default value is UTILIZATION. Possible values are: UTILIZATION, RATE, CONNECTION.

    CapacityScaler float64

    A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). 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.

    MaxConnections int

    The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. 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. 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. 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. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For 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.

    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.

    MaxUtilization float64

    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

    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. 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. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). See the Backend Services Overview for an explanation of load balancing modes. Default value is UTILIZATION. Possible values are: UTILIZATION, RATE, CONNECTION.

    capacityScaler Double

    A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). 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.

    maxConnections Integer

    The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. 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. 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. 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. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For 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.

    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.

    maxUtilization Double

    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

    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. 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. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). See the Backend Services Overview for an explanation of load balancing modes. Default value is UTILIZATION. Possible values are: UTILIZATION, RATE, CONNECTION.

    capacityScaler number

    A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). 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.

    maxConnections number

    The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. 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. 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. 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. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For 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.

    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.

    maxUtilization number

    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

    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. 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. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). See the Backend Services Overview for an explanation of load balancing modes. Default value is UTILIZATION. 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). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). 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.

    max_connections int

    The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. 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. 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. 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. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For 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.

    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.

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

    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. 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. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). See the Backend Services Overview for an explanation of load balancing modes. Default value is UTILIZATION. Possible values are: UTILIZATION, RATE, CONNECTION.

    capacityScaler Number

    A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). 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.

    maxConnections Number

    The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. 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. 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. 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. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For 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.

    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.

    maxUtilization Number

    Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

    BackendServiceCdnPolicy, BackendServiceCdnPolicyArgs

    BypassCacheOnRequestHeaders List<BackendServiceCdnPolicyBypassCacheOnRequestHeader>

    Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. Structure is documented below.

    CacheKeyPolicy BackendServiceCdnPolicyCacheKeyPolicy

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

    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.

    BypassCacheOnRequestHeaders []BackendServiceCdnPolicyBypassCacheOnRequestHeader

    Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. Structure is documented below.

    CacheKeyPolicy BackendServiceCdnPolicyCacheKeyPolicy

    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 []BackendServiceCdnPolicyNegativeCachingPolicy

    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.

    bypassCacheOnRequestHeaders List<BackendServiceCdnPolicyBypassCacheOnRequestHeader>

    Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. Structure is documented below.

    cacheKeyPolicy BackendServiceCdnPolicyCacheKeyPolicy

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

    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.

    bypassCacheOnRequestHeaders BackendServiceCdnPolicyBypassCacheOnRequestHeader[]

    Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. Structure is documented below.

    cacheKeyPolicy BackendServiceCdnPolicyCacheKeyPolicy

    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 BackendServiceCdnPolicyNegativeCachingPolicy[]

    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.

    bypass_cache_on_request_headers Sequence[BackendServiceCdnPolicyBypassCacheOnRequestHeader]

    Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. Structure is documented below.

    cache_key_policy BackendServiceCdnPolicyCacheKeyPolicy

    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[BackendServiceCdnPolicyNegativeCachingPolicy]

    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.

    bypassCacheOnRequestHeaders List<Property Map>

    Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings. Structure is documented below.

    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.

    BackendServiceCdnPolicyBypassCacheOnRequestHeader, BackendServiceCdnPolicyBypassCacheOnRequestHeaderArgs

    HeaderName string

    The header field name to match on when bypassing cache. Values are case-insensitive.

    HeaderName string

    The header field name to match on when bypassing cache. Values are case-insensitive.

    headerName String

    The header field name to match on when bypassing cache. Values are case-insensitive.

    headerName string

    The header field name to match on when bypassing cache. Values are case-insensitive.

    header_name str

    The header field name to match on when bypassing cache. Values are case-insensitive.

    headerName String

    The header field name to match on when bypassing cache. Values are case-insensitive.

    BackendServiceCdnPolicyCacheKeyPolicy, BackendServiceCdnPolicyCacheKeyPolicyArgs

    IncludeHost bool

    If true requests to different hosts will be cached separately.

    IncludeHttpHeaders List<string>

    Allows HTTP request headers (by name) to be used in the cache key.

    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.

    IncludeHttpHeaders []string

    Allows HTTP request headers (by name) to be used in the cache key.

    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.

    includeHttpHeaders List<String>

    Allows HTTP request headers (by name) to be used in the cache key.

    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.

    includeHttpHeaders string[]

    Allows HTTP request headers (by name) to be used in the cache key.

    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_http_headers Sequence[str]

    Allows HTTP request headers (by name) to be used in the cache key.

    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.

    includeHttpHeaders List<String>

    Allows HTTP request headers (by name) to be used in the cache key.

    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.

    BackendServiceCdnPolicyNegativeCachingPolicy, BackendServiceCdnPolicyNegativeCachingPolicyArgs

    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.

    BackendServiceCircuitBreakers, BackendServiceCircuitBreakersArgs

    ConnectTimeout BackendServiceCircuitBreakersConnectTimeout

    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 BackendServiceCircuitBreakersConnectTimeout

    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 BackendServiceCircuitBreakersConnectTimeout

    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 BackendServiceCircuitBreakersConnectTimeout

    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 BackendServiceCircuitBreakersConnectTimeout

    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.

    BackendServiceCircuitBreakersConnectTimeout, BackendServiceCircuitBreakersConnectTimeoutArgs

    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.

    BackendServiceConsistentHash, BackendServiceConsistentHashArgs

    HttpCookie BackendServiceConsistentHashHttpCookie

    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 BackendServiceConsistentHashHttpCookie

    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 BackendServiceConsistentHashHttpCookie

    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 BackendServiceConsistentHashHttpCookie

    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 BackendServiceConsistentHashHttpCookie

    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.

    BackendServiceConsistentHashHttpCookie, BackendServiceConsistentHashHttpCookieArgs

    Name string

    Name of the cookie.

    Path string

    Path to set for the cookie.

    Ttl BackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    Name string

    Name of the cookie.

    Path string

    Path to set for the cookie.

    Ttl BackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    name String

    Name of the cookie.

    path String

    Path to set for the cookie.

    ttl BackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    name string

    Name of the cookie.

    path string

    Path to set for the cookie.

    ttl BackendServiceConsistentHashHttpCookieTtl

    Lifetime of the cookie. Structure is documented below.

    name str

    Name of the cookie.

    path str

    Path to set for the cookie.

    ttl BackendServiceConsistentHashHttpCookieTtl

    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.

    BackendServiceConsistentHashHttpCookieTtl, BackendServiceConsistentHashHttpCookieTtlArgs

    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.

    BackendServiceIap, BackendServiceIapArgs

    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.

    BackendServiceLocalityLbPolicy, BackendServiceLocalityLbPolicyArgs

    CustomPolicy BackendServiceLocalityLbPolicyCustomPolicy

    The configuration for a custom policy implemented by the user and deployed with the client. Structure is documented below.

    Policy BackendServiceLocalityLbPolicyPolicy

    The configuration for a built-in load balancing policy. Structure is documented below.

    CustomPolicy BackendServiceLocalityLbPolicyCustomPolicy

    The configuration for a custom policy implemented by the user and deployed with the client. Structure is documented below.

    Policy BackendServiceLocalityLbPolicyPolicy

    The configuration for a built-in load balancing policy. Structure is documented below.

    customPolicy BackendServiceLocalityLbPolicyCustomPolicy

    The configuration for a custom policy implemented by the user and deployed with the client. Structure is documented below.

    policy BackendServiceLocalityLbPolicyPolicy

    The configuration for a built-in load balancing policy. Structure is documented below.

    customPolicy BackendServiceLocalityLbPolicyCustomPolicy

    The configuration for a custom policy implemented by the user and deployed with the client. Structure is documented below.

    policy BackendServiceLocalityLbPolicyPolicy

    The configuration for a built-in load balancing policy. Structure is documented below.

    custom_policy BackendServiceLocalityLbPolicyCustomPolicy

    The configuration for a custom policy implemented by the user and deployed with the client. Structure is documented below.

    policy BackendServiceLocalityLbPolicyPolicy

    The configuration for a built-in load balancing policy. Structure is documented below.

    customPolicy Property Map

    The configuration for a custom policy implemented by the user and deployed with the client. Structure is documented below.

    policy Property Map

    The configuration for a built-in load balancing policy. Structure is documented below.

    BackendServiceLocalityLbPolicyCustomPolicy, BackendServiceLocalityLbPolicyCustomPolicyArgs

    Name string

    Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.

    Data string

    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

    Name string

    Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.

    Data string

    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

    name String

    Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.

    data String

    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

    name string

    Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.

    data string

    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

    name str

    Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.

    data str

    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

    name String

    Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.

    data String

    An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.

    BackendServiceLocalityLbPolicyPolicy, BackendServiceLocalityLbPolicyPolicyArgs

    Name string

    The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected. The possible values are:

    Name string

    The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected. The possible values are:

    name String

    The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected. The possible values are:

    name string

    The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected. The possible values are:

    name str

    The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected. The possible values are:

    name String

    The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected. The possible values are:

    BackendServiceLogConfig, BackendServiceLogConfigArgs

    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.

    BackendServiceOutlierDetection, BackendServiceOutlierDetectionArgs

    BaseEjectionTime BackendServiceOutlierDetectionBaseEjectionTime

    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 BackendServiceOutlierDetectionInterval

    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 BackendServiceOutlierDetectionBaseEjectionTime

    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 BackendServiceOutlierDetectionInterval

    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 BackendServiceOutlierDetectionBaseEjectionTime

    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 BackendServiceOutlierDetectionInterval

    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 BackendServiceOutlierDetectionBaseEjectionTime

    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 BackendServiceOutlierDetectionInterval

    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 BackendServiceOutlierDetectionBaseEjectionTime

    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 BackendServiceOutlierDetectionInterval

    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.

    BackendServiceOutlierDetectionBaseEjectionTime, BackendServiceOutlierDetectionBaseEjectionTimeArgs

    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.

    BackendServiceOutlierDetectionInterval, BackendServiceOutlierDetectionIntervalArgs

    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.

    BackendServiceSecuritySettings, BackendServiceSecuritySettingsArgs

    ClientTlsPolicy string

    ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

    SubjectAltNames List<string>

    A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.

    ClientTlsPolicy string

    ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

    SubjectAltNames []string

    A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.

    clientTlsPolicy String

    ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

    subjectAltNames List<String>

    A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.

    clientTlsPolicy string

    ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

    subjectAltNames string[]

    A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.

    client_tls_policy str

    ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

    subject_alt_names Sequence[str]

    A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.

    clientTlsPolicy String

    ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

    subjectAltNames List<String>

    A list of alternate names to verify the subject identity in the certificate. If specified, the client will verify that the server certificate's subject alt name matches one of the specified values.

    Import

    BackendService can be imported using any of these accepted formats

     $ pulumi import gcp:compute/backendService:BackendService default projects/{{project}}/global/backendServices/{{name}}
    
     $ pulumi import gcp:compute/backendService:BackendService default {{project}}/{{name}}
    
     $ pulumi import gcp:compute/backendService:BackendService 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 v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi