gcp_compute_backend_service

Type: INT32
Provider name: affinityCookieTtlSec
Description: Lifetime of cookies in seconds. This setting is applicable to Application Load Balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. 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 is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

ancestors

Type: UNORDERED_LIST_STRING

backends

Type: UNORDERED_LIST_STRUCT
Provider name: backends
Description: The list of backends that serve this BackendService.

  • balancing_mode
    Type: STRING
    Provider name: balancingMode
    Description: Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
    Possible values:
    • CONNECTION - Balance based on the number of simultaneous connections.
    • CUSTOM_METRICS - Based on custom defined and reported metrics.
    • RATE - Balance based on requests per second (RPS).
    • UTILIZATION - Balance based on the backend utilization.
  • capacity_scaler
    Type: FLOAT
    Provider name: capacityScaler
    Description: A multiplier applied to the backend’s target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don’t support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
  • custom_metrics
    Type: UNORDERED_LIST_STRUCT
    Provider name: customMetrics
    Description: List of custom metrics that are used for CUSTOM_METRICS BalancingMode.
    • dry_run
      Type: BOOLEAN
      Provider name: dryRun
      Description: If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.
    • max_utilization
      Type: FLOAT
      Provider name: maxUtilization
      Description: Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].
    • name
      Type: STRING
      Provider name: name
      Description: Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
  • description
    Type: STRING
    Provider name: description
    Description: An optional description of this resource. Provide this property when you create the resource.
  • failover
    Type: BOOLEAN
    Provider name: failover
    Description: This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
  • group
    Type: STRING
    Provider name: group
    Description: The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. If haPolicy is specified, backends must refer to NEG resources of type GCE_VM_IP.
  • max_connections
    Type: INT32
    Provider name: maxConnections
    Description: Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend’s balancingMode is RATE.
  • max_connections_per_endpoint
    Type: INT32
    Provider name: maxConnectionsPerEndpoint
    Description: Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend’s balancingMode is RATE.
  • max_connections_per_instance
    Type: INT32
    Provider name: maxConnectionsPerInstance
    Description: Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend’s balancingMode is RATE.
  • max_rate
    Type: INT32
    Provider name: maxRate
    Description: Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend’s balancingMode is CONNECTION.
  • max_rate_per_endpoint
    Type: FLOAT
    Provider name: maxRatePerEndpoint
    Description: Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend’s balancingMode is CONNECTION.
  • max_rate_per_instance
    Type: FLOAT
    Provider name: maxRatePerInstance
    Description: Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend’s balancingMode is CONNECTION.
  • max_utilization
    Type: FLOAT
    Provider name: maxUtilization
    Description: Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.
  • preference
    Type: STRING
    Provider name: preference
    Description: This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don’t have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default
    Possible values:
    • DEFAULT - No preference.
    • PREFERENCE_UNSPECIFIED - If preference is unspecified, we set it to the DEFAULT value
    • PREFERRED - Traffic will be sent to this backend first.

cdn_policy

Type: STRUCT
Provider name: cdnPolicy
Description: Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

  • bypass_cache_on_request_headers
    Type: UNORDERED_LIST_STRUCT
    Provider name: bypassCacheOnRequestHeaders
    Description: 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.
    • header_name
      Type: STRING
      Provider name: headerName
      Description: The header field name to match on when bypassing cache. Values are case-insensitive.
  • cache_key_policy
    Type: STRUCT
    Provider name: cacheKeyPolicy
    Description: The CacheKeyPolicy for this CdnPolicy.
    • include_host
      Type: BOOLEAN
      Provider name: includeHost
      Description: If true, requests to different hosts will be cached separately.
    • include_http_headers
      Type: UNORDERED_LIST_STRING
      Provider name: includeHttpHeaders
      Description: Allows HTTP request headers (by name) to be used in the cache key.
    • include_named_cookies
      Type: UNORDERED_LIST_STRING
      Provider name: includeNamedCookies
      Description: Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.
    • include_protocol
      Type: BOOLEAN
      Provider name: includeProtocol
      Description: If true, http and https requests will be cached separately.
    • include_query_string
      Type: BOOLEAN
      Provider name: includeQueryString
      Description: 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_blacklist
      Type: UNORDERED_LIST_STRING
      Provider name: queryStringBlacklist
      Description: 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_whitelist
      Type: UNORDERED_LIST_STRING
      Provider name: queryStringWhitelist
      Description: 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.
  • cache_mode
    Type: STRING
    Provider name: cacheMode
    Description: Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google’s edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any “private”, “no-store” or “no-cache” directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. If no value is provided for cdnPolicy.cacheMode, it defaults to CACHE_ALL_STATIC.
    Possible values:
    • CACHE_ALL_STATIC - Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
    • FORCE_CACHE_ALL - Cache all content, ignoring any ‘private
    • INVALID_CACHE_MODE - no-store’ or ’no-cache’ directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
    • USE_ORIGIN_HEADERS
  • client_ttl
    Type: INT32
    Provider name: clientTtl
    Description: Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a “public” directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a “public” cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).
  • default_ttl
    Type: INT32
    Provider name: defaultTtl
    Description: 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-maxage). Setting a TTL of “0” means “always revalidate”. The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
  • max_ttl
    Type: INT32
    Provider name: maxTtl
    Description: Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of “0” means “always revalidate”. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
  • negative_caching
    Type: BOOLEAN
    Provider name: negativeCaching
    Description: Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
  • negative_caching_policy
    Type: UNORDERED_LIST_STRUCT
    Provider name: negativeCachingPolicy
    Description: Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN’s default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
    • code
      Type: INT32
      Provider name: code
      Description: The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
    • ttl
      Type: INT32
      Provider name: ttl
      Description: 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.
  • request_coalescing
    Type: BOOLEAN
    Provider name: requestCoalescing
    Description: If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
  • serve_while_stale
    Type: INT32
    Provider name: serveWhileStale
    Description: Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default “max-stale” duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-maxage) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
  • signed_url_cache_max_age_sec
    Type: INT64
    Provider name: signedUrlCacheMaxAgeSec
    Description: Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). 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.
  • signed_url_key_names
    Type: UNORDERED_LIST_STRING
    Provider name: signedUrlKeyNames
    Description: [Output Only] Names of the keys for signing request URLs.

circuit_breakers

Type: STRUCT
Provider name: circuitBreakers

  • max_connections
    Type: INT32
    Provider name: maxConnections
    Description: The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
  • max_pending_requests
    Type: INT32
    Provider name: maxPendingRequests
    Description: The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
  • max_requests
    Type: INT32
    Provider name: maxRequests
    Description: The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
  • max_requests_per_connection
    Type: INT32
    Provider name: maxRequestsPerConnection
    Description: Maximum requests for a single connection to the backend service. 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
  • max_retries
    Type: INT32
    Provider name: maxRetries
    Description: The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

compression_mode

Type: STRING
Provider name: compressionMode
Description: Compress text responses using Brotli or gzip compression, based on the client’s Accept-Encoding header.
Possible values:

  • AUTOMATIC - Automatically uses the best compression based on the Accept-Encoding header sent by the client.
  • DISABLED - Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients.

connection_draining

Type: STRUCT
Provider name: connectionDraining
Description: connectionDraining cannot be specified with haPolicy.

  • draining_timeout_sec
    Type: INT32
    Provider name: drainingTimeoutSec
    Description: Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.

connection_tracking_policy

Type: STRUCT
Provider name: connectionTrackingPolicy
Description: Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy.

  • connection_persistence_on_unhealthy_backends
    Type: STRING
    Provider name: connectionPersistenceOnUnhealthyBackends
    Description: Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing.
    Possible values:
    • ALWAYS_PERSIST
    • DEFAULT_FOR_PROTOCOL
    • NEVER_PERSIST
  • enable_strong_affinity
    Type: BOOLEAN
    Provider name: enableStrongAffinity
    Description: Enable Strong Session Affinity for external passthrough Network Load Balancers. This option is not available publicly.
  • idle_timeout_sec
    Type: INT32
    Provider name: idleTimeoutSec
    Description: Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For internal passthrough Network Load Balancers: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For external passthrough Network Load Balancers the default is 60 seconds. This option is not available publicly.
  • tracking_mode
    Type: STRING
    Provider name: trackingMode
    Description: Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing.
    Possible values:
    • INVALID_TRACKING_MODE
    • PER_CONNECTION
    • PER_SESSION

consistent_hash

Type: STRUCT
Provider name: consistentHash
Description: 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 is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

  • http_cookie
    Type: STRUCT
    Provider name: httpCookie
    Description: 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. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
    • name
      Type: STRING
      Provider name: name
      Description: Name of the cookie.
    • path
      Type: STRING
      Provider name: path
      Description: Path to set for the cookie.
    • ttl
      Type: STRUCT
      Provider name: ttl
      Description: Lifetime of the cookie.
      • nanos
        Type: INT32
        Provider name: nanos
        Description: 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
        Type: INT64
        Provider name: seconds
        Description: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
  • http_header_name
    Type: STRING
    Provider name: httpHeaderName
    Description: 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
    Type: INT64
    Provider name: minimumRingSize
    Description: The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. 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.

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in RFC3339 text format.

custom_metrics

Type: UNORDERED_LIST_STRUCT
Provider name: customMetrics
Description: List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy.

  • dry_run
    Type: BOOLEAN
    Provider name: dryRun
    Description: If true, the metric data is not used for load balancing.
  • name
    Type: STRING
    Provider name: name
    Description: Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

custom_request_headers

Type: UNORDERED_LIST_STRING
Provider name: customRequestHeaders
Description: Headers that the load balancer adds to proxied requests. See Creating custom headers.

custom_response_headers

Type: UNORDERED_LIST_STRING
Provider name: customResponseHeaders
Description: Headers that the load balancer adds to proxied responses. See Creating custom headers.

description

Type: STRING
Provider name: description
Description: An optional description of this resource. Provide this property when you create the resource.

edge_security_policy

Type: STRING
Provider name: edgeSecurityPolicy
Description: [Output Only] The resource URL for the edge security policy associated with this backend service.

enable_cdn

Type: BOOLEAN
Provider name: enableCDN
Description: If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.

external_managed_migration_state

Type: STRING
Provider name: externalManagedMigrationState
Description: Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
Possible values:

  • PREPARE
  • TEST_ALL_TRAFFIC
  • TEST_BY_PERCENTAGE

external_managed_migration_testing_percentage

Type: FLOAT
Provider name: externalManagedMigrationTestingPercentage
Description: Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.

failover_policy

Type: STRUCT
Provider name: failoverPolicy
Description: Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal passthrough Network Load Balancers and external passthrough Network Load Balancers. failoverPolicy cannot be specified with haPolicy.

  • disable_connection_drain_on_failover
    Type: BOOLEAN
    Provider name: disableConnectionDrainOnFailover
    Description: This can be set to true only if the protocol is TCP. The default is false.
  • drop_traffic_if_unhealthy
    Type: BOOLEAN
    Provider name: dropTrafficIfUnhealthy
    Description: If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: Internal passthrough Network Load Balancers and external passthrough Network Load Balancers. The default is false.
  • failover_ratio
    Type: FLOAT
    Provider name: failoverRatio
    Description: The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.

ha_policy

Type: STRUCT
Provider name: haPolicy
Description: Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers.

  • fast_ip_move
    Type: STRING
    Provider name: fastIPMove
    Description: Specifies whether fast IP move is enabled, and if so, the mechanism to achieve it. Supported values are: - DISABLED: Fast IP Move is disabled. You can only use the haPolicy.leader API to update the leader. - >GARP_RA: Provides a method to very quickly define a new network endpoint as the leader. This method is faster than updating the leader using the haPolicy.leader API. Fast IP move works as follows: The VM hosting the network endpoint that should become the new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud immediately but temporarily associates the forwarding rule IP address with that VM, and both new and in-flight packets are quickly delivered to that VM. Note the important properties of the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays active for approximately 20 minutes. After triggering fast failover, you must also appropriately set the haPolicy.leader. - The new leader instance should continue to send GARP/RA packets periodically every 10 seconds until at least 10 minutes after updating the haPolicy.leader (but stop immediately if it is no longer the leader). - After triggering a fast failover, we recommend that you wait at least 3 seconds before sending another GARP/RA packet from a different VM instance to avoid race conditions. - Don’t send GARP/RA packets from different VM instances at the same time. If multiple instances continue to send GARP/RA packets, traffic might be routed to different destinations in an alternating order. This condition ceases when a single instance issues a GARP/RA packet. - The GARP/RA request always takes priority over the leader API. Using the haPolicy.leader API to change the leader to a different instance will have no effect until the GARP/RA request becomes inactive. - The GARP/RA packets should follow the GARP/RA Packet Specifications.. - When multiple forwarding rules refer to a regional backend service, you need only send a GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs for all forwarding rules targeting the same backend service will also be moved to the sender of the GARP or RA packet. The following are the Fast IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple forwarding rules cannot use the same IP address if one of them refers to a regional backend service with fastIPMove. - The regional backend service must set the network field, and all NEGs must belong to that network. However, individual NEGs can belong to different subnetworks of that network. - The maximum number of network endpoints across all backends of a backend service with fastIPMove is 64. - The maximum number of backend services with fastIPMove that can have the same network endpoint attached to one of its backends is 64. - The maximum number of backend services with fastIPMove in a VPC in a region is 64. - The network endpoints that are attached to a backend of a backend service with fastIPMove cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a static route next hop will not be redirected to a new leader by fast failover. Such traffic will only be redirected once an haPolicy.leader update has taken effect. Only traffic to the forwarding rule’s virtual IP will be redirected to a new leader by fast failover. haPolicy.fastIPMove can be set only at backend service creation time. Once set, it cannot be updated. By default, fastIpMove is set to DISABLED.
    Possible values:
    • DISABLED
    • GARP_RA

health_checks

Type: UNORDERED_LIST_STRING
Provider name: healthChecks
Description: The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.

iap

Type: STRUCT
Provider name: iap
Description: The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.

  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: Whether the serving infrastructure will authenticate and authorize all incoming requests.
  • oauth2_client_id
    Type: STRING
    Provider name: oauth2ClientId
    Description: OAuth2 client ID to use for the authentication flow.
  • oauth2_client_secret
    Type: STRING
    Provider name: oauth2ClientSecret
    Description: OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly
  • oauth2_client_secret_sha256
    Type: STRING
    Provider name: oauth2ClientSecretSha256
    Description: [Output Only] SHA256 hash value for the field oauth2_client_secret above.

id

Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

ip_address_selection_policy

Type: STRING
Provider name: ipAddressSelectionPolicy
Description: Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint’s IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED).
Possible values:

  • IPV4_ONLY - Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting.
  • IPV6_ONLY - Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends.
  • IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED - Unspecified IP address selection policy.
  • PREFER_IPV6 - Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address).

kind

Type: STRING
Provider name: kind
Description: [Output Only] Type of resource. Always compute#backendService for backend services.

labels

Type: UNORDERED_LIST_STRING

load_balancing_scheme

Type: STRING
Provider name: loadBalancingScheme
Description: Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Possible values:

  • EXTERNAL - Signifies that this will be used for classic Application Load Balancers, global external proxy Network Load Balancers, or external passthrough Network Load Balancers.
  • EXTERNAL_MANAGED - Signifies that this will be used for global external Application Load Balancers, regional external Application Load Balancers, or regional external proxy Network Load Balancers.
  • INTERNAL - Signifies that this will be used for internal passthrough Network Load Balancers.
  • INTERNAL_MANAGED - Signifies that this will be used for internal Application Load Balancers.
  • INTERNAL_SELF_MANAGED - Signifies that this will be used by Traffic Director.
  • INVALID_LOAD_BALANCING_SCHEME

locality_lb_policies

Type: UNORDERED_LIST_STRUCT
Provider name: localityLbPolicies
Description: A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can’t use backend services that have this configuration.

  • custom_policy
    Type: STRUCT
    Provider name: customPolicy
    • data
      Type: STRING
      Provider name: data
      Description: An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.
    • name
      Type: STRING
      Provider name: name
      Description: Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.
  • policy
    Type: STRUCT
    Provider name: policy
    • name
      Type: STRING
      Provider name: name
      Description: The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.
      Possible values:
      • INVALID_LB_POLICY
      • LEAST_REQUEST - An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
      • MAGLEV - This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
      • ORIGINAL_DESTINATION - Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
      • RANDOM - The load balancer selects a random healthy host.
      • RING_HASH - The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
      • ROUND_ROBIN - This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
      • WEIGHTED_MAGLEV - Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.
      • WEIGHTED_ROUND_ROBIN - Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields.

locality_lb_policy

Type: STRING
Provider name: localityLbPolicy
Description: The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 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. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. localityLbPolicy cannot be specified with haPolicy.
Possible values:

  • INVALID_LB_POLICY
  • LEAST_REQUEST - An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
  • MAGLEV - This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
  • ORIGINAL_DESTINATION - Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
  • RANDOM - The load balancer selects a random healthy host.
  • RING_HASH - The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
  • ROUND_ROBIN - This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
  • WEIGHTED_MAGLEV - Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.
  • WEIGHTED_ROUND_ROBIN - Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields.

log_config

Type: STRUCT
Provider name: logConfig
Description: 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.

  • enable
    Type: BOOLEAN
    Provider name: enable
    Description: Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
  • optional_fields
    Type: UNORDERED_LIST_STRING
    Provider name: optionalFields
    Description: This field can only be specified if logging is enabled for this backend service and “logConfig.optionalMode” was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
  • optional_mode
    Type: STRING
    Provider name: optionalMode
    Description: This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
    Possible values:
    • CUSTOM - A subset of optional fields.
    • EXCLUDE_ALL_OPTIONAL - None optional fields.
    • INCLUDE_ALL_OPTIONAL - All optional fields.
  • sample_rate
    Type: FLOAT
    Provider name: sampleRate
    Description: 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.

max_stream_duration

Type: STRUCT
Provider name: maxStreamDuration
Description: Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.

  • nanos
    Type: INT32
    Provider name: nanos
    Description: 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
    Type: INT64
    Provider name: seconds
    Description: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

name

Type: STRING
Provider name: name
Description: 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]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

network

Type: STRING
Provider name: network
Description: The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL.

organization_id

Type: STRING

outlier_detection

Type: STRUCT
Provider name: outlierDetection
Description: Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

  • base_ejection_time
    Type: STRUCT
    Provider name: baseEjectionTime
    Description: The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.
    • nanos
      Type: INT32
      Provider name: nanos
      Description: 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
      Type: INT64
      Provider name: seconds
      Description: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
  • consecutive_errors
    Type: INT32
    Provider name: consecutiveErrors
    Description: Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
  • consecutive_gateway_failure
    Type: INT32
    Provider name: consecutiveGatewayFailure
    Description: 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 3.
  • enforcing_consecutive_errors
    Type: INT32
    Provider name: enforcingConsecutiveErrors
    Description: The percentage chance that a backend endpoint will be 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 0.
  • enforcing_consecutive_gateway_failure
    Type: INT32
    Provider name: enforcingConsecutiveGatewayFailure
    Description: The percentage chance that a backend endpoint will be 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 100.
  • enforcing_success_rate
    Type: INT32
    Provider name: enforcingSuccessRate
    Description: The percentage chance that a backend endpoint will be 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. Not supported when the backend service uses Serverless NEG.
  • interval
    Type: STRUCT
    Provider name: interval
    Description: Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.
    • nanos
      Type: INT32
      Provider name: nanos
      Description: 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
      Type: INT64
      Provider name: seconds
      Description: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
  • max_ejection_percent
    Type: INT32
    Provider name: maxEjectionPercent
    Description: Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.
  • success_rate_minimum_hosts
    Type: INT32
    Provider name: successRateMinimumHosts
    Description: The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.
  • success_rate_request_volume
    Type: INT32
    Provider name: successRateRequestVolume
    Description: The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint 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 backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.
  • success_rate_stdev_factor
    Type: INT32
    Provider name: successRateStdevFactor
    Description: 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 * successRateStdevFactor). 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. Not supported when the backend service uses Serverless NEG.

parent

Type: STRING

port

Type: INT32
Provider name: port
Description: Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port.

port_name

Type: STRING
Provider name: portName
Description: A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name.

project_id

Type: STRING

project_number

Type: STRING

protocol

Type: STRING
Provider name: protocol
Description: The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
Possible values:

  • GRPC - gRPC (available for Traffic Director).
  • HTTP
  • HTTP2 - HTTP/2 with SSL.
  • HTTPS
  • SSL - TCP proxying with SSL.
  • TCP - TCP proxying or TCP pass-through.
  • UDP - UDP.
  • UNSPECIFIED - If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules.

region

Type: STRING
Provider name: region
Description: [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

resource_name

Type: STRING

security_policy

Type: STRING
Provider name: securityPolicy
Description: [Output Only] The resource URL for the security policy associated with this backend service.

security_settings

Type: STRUCT
Provider name: securitySettings
Description: This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

  • aws_v4_authentication
    Type: STRUCT
    Provider name: awsV4Authentication
    Description: The configuration needed to generate a signature for access to private storage buckets that support AWS’s Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
    • access_key
      Type: STRING
      Provider name: accessKey
      Description: The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
    • access_key_id
      Type: STRING
      Provider name: accessKeyId
      Description: The identifier of an access key used for s3 bucket authentication.
    • access_key_version
      Type: STRING
      Provider name: accessKeyVersion
      Description: The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
    • origin_region
      Type: STRING
      Provider name: originRegion
      Description: The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, “us-east-1” for AWS or “us-ashburn-1” for OCI.
  • client_tls_policy
    Type: STRING
    Provider name: clientTlsPolicy
    Description: Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service’s backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.
  • subject_alt_names
    Type: UNORDERED_LIST_STRING
    Provider name: subjectAltNames
    Description: Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate’s subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate’s subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).

Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined URL for the resource.

service_bindings

Type: UNORDERED_LIST_STRING
Provider name: serviceBindings
Description: URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

service_lb_policy

Type: STRING
Provider name: serviceLbPolicy
Description: URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.

session_affinity

Type: STRING
Provider name: sessionAffinity
Description: Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity. sessionAffinity cannot be specified with haPolicy.
Possible values:

  • CLIENT_IP - 2-tuple hash on packet’s source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.
  • CLIENT_IP_NO_DESTINATION - 1-tuple hash only on packet’s source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.
  • CLIENT_IP_PORT_PROTO - 5-tuple hash on packet’s source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
  • CLIENT_IP_PROTO - 3-tuple hash on packet’s source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.
  • GENERATED_COOKIE - Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.
  • HEADER_FIELD - The hash is based on a user specified header field.
  • HTTP_COOKIE - The hash is based on a user provided cookie.
  • NONE - No session affinity. Connections from the same client IP may go to any instance in the pool.
  • STRONG_COOKIE_AFFINITY - Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired.

Type: STRUCT
Provider name: strongSessionAffinityCookie
Description: Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.

  • name
    Type: STRING
    Provider name: name
    Description: Name of the cookie.
  • path
    Type: STRING
    Provider name: path
    Description: Path to set for the cookie.
  • ttl
    Type: STRUCT
    Provider name: ttl
    Description: Lifetime of the cookie.
    • nanos
      Type: INT32
      Provider name: nanos
      Description: 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
      Type: INT64
      Provider name: seconds
      Description: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

subsetting

Type: STRUCT
Provider name: subsetting
Description: subsetting cannot be specified with haPolicy.

  • policy
    Type: STRING
    Provider name: policy

tags

Type: UNORDERED_LIST_STRING

timeout_sec

Type: INT32
Provider name: timeoutSec
Description: The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.

used_by

Type: UNORDERED_LIST_STRUCT
Provider name: usedBy
Description: [Output Only] List of resources referencing given backend service.

  • reference
    Type: STRING
    Provider name: reference
    Description: [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.
PREVIEWING: yuqing.bian/fix-sources-searchterm