File: //snap/google-cloud-cli/396/lib/googlecloudsdk/schemas/compute/beta/BackendService.yaml
$schema: "http://json-schema.org/draft-06/schema#"
title: compute beta BackendService export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
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.
type: integer
backends:
description: The list of backends that serve this BackendService.
type: array
items:
$ref: Backend.yaml
cdnPolicy:
description: |-
Cloud CDN configuration for this BackendService. Only available for
specified load balancer types.
$ref: BackendServiceCdnPolicy.yaml
circuitBreakers:
description: A CircuitBreakers attribute.
$ref: CircuitBreakers.yaml
compressionMode:
description: |-
Compress text responses using Brotli or gzip compression, based on the
client's Accept-Encoding header.
type: string
enum:
- AUTOMATIC
- DISABLED
connectionDraining:
description: connectionDraining cannot be specified with haPolicy.
$ref: ConnectionDraining.yaml
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.
$ref: BackendServiceConnectionTrackingPolicy.yaml
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, HTTP2 or H2C, and
load_balancing_scheme set to INTERNAL_MANAGED. - A global backend
service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
$ref: ConsistentHashLoadBalancerSettings.yaml
creationTimestamp:
description: '[Output Only] Creation timestamp in RFC3339 text format.'
type: string
customMetrics:
description: |-
List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN
locality_lb_policy.
type: array
items:
$ref: BackendServiceCustomMetric.yaml
customRequestHeaders:
description: |-
Headers that the load balancer adds to proxied requests. See
[Creating custom headers](https://cloud.google.com/load-
balancing/docs/custom-headers).
type: array
items:
type: string
customResponseHeaders:
description: |-
Headers that the load balancer adds to proxied responses. See
[Creating custom headers](https://cloud.google.com/load-
balancing/docs/custom-headers).
type: array
items:
type: string
description:
description: |-
An optional description of this resource. Provide this
property when you create the resource.
type: string
dynamicForwarding:
description: |-
Dynamic forwarding configuration. This field is used to
configure the backend service with dynamic forwarding
feature which together with Service Extension allows
customized and complex routing logic.
$ref: BackendServiceDynamicForwarding.yaml
edgeSecurityPolicy:
description: |-
[Output Only] The resource URL for the edge security
policy associated with this backend service.
type: string
enableCDN:
description: |-
If true, enables Cloud CDN for the backend service of a
global external Application Load Balancer.
type: boolean
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.
type: string
enum:
- PREPARE
- TEST_ALL_TRAFFIC
- TEST_BY_PERCENTAGE
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.
type: number
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](https://cloud.google.com/load-
balancing/docs/internal/failover-overview) and [external
passthrough Network Load
Balancers](https://cloud.google.com/load-
balancing/docs/network/networklb-failover-overview).
failoverPolicy cannot be specified with haPolicy.
$ref: BackendServiceFailoverPolicy.yaml
fingerprint:
description: |-
Fingerprint of this resource. A hash of the contents
stored in this object. This field is used in optimistic
locking. This field will be ignored when inserting a
BackendService. An up-to-date fingerprint must be provided
in order to update the BackendService, otherwise the
request will fail with error 412 conditionNotMet. To see
the latest fingerprint, make a get() request to retrieve a
BackendService.
type: string
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.
$ref: BackendServiceHAPolicy.yaml
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.
type: array
items:
type: string
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.
$ref: BackendServiceIAP.yaml
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).
type: string
enum:
- IPV4_ONLY
- IPV6_ONLY
- IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED
- PREFER_IPV6
kind:
description: |-
[Output Only] Type of resource. Always
compute#backendService for backend services.
type: string
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.
type: string
enum:
- EXTERNAL
- EXTERNAL_MANAGED
- INTERNAL
- INTERNAL_MANAGED
- INTERNAL_SELF_MANAGED
- INVALID_LOAD_BALANCING_SCHEME
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.
type: array
items:
$ref: BackendServiceLocalityLoadBalancingPolicyConfig.yaml
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. -
type: string
enum:
- INVALID_LB_POLICY
- LEAST_REQUEST
- MAGLEV
- ORIGINAL_DESTINATION
- RANDOM
- RING_HASH
- ROUND_ROBIN
- WEIGHTED_GCP_RENDEZVOUS
- WEIGHTED_MAGLEV
- WEIGHTED_ROUND_ROBIN
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.
$ref: BackendServiceLogConfig.yaml
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.
$ref: Duration.yaml
metadatas:
description: |-
Deployment metadata associated with the resource
to be set by a GKE hub controller and read by the
backend RCTH
$ref: MetadatasValue.yaml
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.
type: string
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, or when the load balancing
scheme is set to EXTERNAL and haPolicy fastIpMove
is enabled.
type: string
networkPassThroughLbTrafficPolicy:
description: |-
Configures traffic steering properties of internal
passthrough Network Load Balancers.
networkPassThroughLbTrafficPolicy cannot be
specified with haPolicy.
$ref: BackendServiceNetworkPassThroughLbTrafficPolicy.yaml
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, HTTP2 or H2C, 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.
$ref: OutlierDetection.yaml
params:
description: |-
Input only. [Input Only] Additional params passed
with the request, but not persisted as part of
resource payload.
$ref: BackendServiceParams.yaml
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.
type: integer
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](https://cloud.google.com/load-
balancing/docs/backend- service#named_ports). 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.
type: string
protocol:
description: |-
The protocol this BackendService uses to
communicate with backends. Possible values are
HTTP, HTTPS, HTTP2, H2C, 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.
type: string
enum:
- GRPC
- H2C
- HTTP
- HTTP2
- HTTPS
- SSL
- TCP
- UDP
- UNSPECIFIED
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.
type: string
securityPolicy:
description: |-
[Output Only] The resource URL for the security
policy associated with this backend service.
type: string
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.
$ref: SecuritySettings.yaml
selfLink:
description: |-
[Output Only] Server-defined URL for the resource.
type: string
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.
type: array
items:
type: string
serviceLbPolicy:
description: |-
URL to networkservices.ServiceLbPolicy
resource. Can only be set if load balancing
scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED
or INTERNAL_SELF_MANAGED and the scope is
global.
type: string
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](https://cloud.google.com/load-
balancing/docs/backend-
service#session_affinity). sessionAffinity
cannot be specified with haPolicy.
type: string
enum:
- CLIENT_IP
- CLIENT_IP_NO_DESTINATION
- CLIENT_IP_PORT_PROTO
- CLIENT_IP_PROTO
- GENERATED_COOKIE
- HEADER_FIELD
- HTTP_COOKIE
- NONE
- STRONG_COOKIE_AFFINITY
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.
$ref: BackendServiceHttpCookie.yaml
subsetting:
description: |-
subsetting cannot be specified with haPolicy.
$ref: Subsetting.yaml
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.
type: integer
tlsSettings:
description: |-
Configuration for Backend Authenticated TLS
and mTLS. May only be specified when the
backend protocol is SSL, HTTPS or HTTP2.
$ref: BackendServiceTlsSettings.yaml
usedBy:
description: |-
[Output Only] List of resources referencing
given backend service.
type: array
items:
$ref: BackendServiceUsedBy.yaml