RegionBackendServiceRegionBackendService is the Schema for the RegionBackendServices API. A Region Backend Service defines a regionally-scoped group of virtual machines that will serve traffic for load balancing.
TypeMR
Providerprovider-gcp-compute
Groupcompute.gcp.m.upbound.io
Scopenamespaced
Versionv1beta1

1apiVersion: compute.gcp.m.upbound.io/v1beta1

2kind: RegionBackendService

kind
string
metadata
object
spec
object

RegionBackendServiceSpec defines the desired state of RegionBackendService

forProvider
required
object

(No description available)

backend
array

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

array

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.

dryRun
boolean
name
string
failover
boolean
group
string
groupRef
object

Reference to a RegionInstanceGroupManager in compute to populate group.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a RegionInstanceGroupManager in compute to populate group.

namespace
string
policy
object

Policies for selection.

resolve
string
maxRate
number
cdnPolicy
object

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

object

The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

array

Names of cookies to include in cache keys.

array

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.

array

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.

cacheMode
string
clientTtl
number
maxTtl
number
array

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.

code
number
object

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

object

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -

object

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.

name
string
path
string
ttl
object

Lifetime of the cookie. Structure is documented below.

nanos
number
seconds
number
array

List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.

dryRun
boolean
name
string
enableCdn
boolean
object

Policy for failovers. Structure is documented below.

array

The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.

array

References to RegionHealthCheck in compute to populate healthChecks.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a list of RegionHealthCheck in compute to populate healthChecks.

namespace
string
policy
object

Policies for selection.

resolve
string
iap
object

Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.

enabled
boolean
object

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

key
required
string
name
required
string
logConfig
object

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.

enable
boolean
array

Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.

network
string
object

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

object

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.

nanos
number
seconds
number
interval
object

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.

nanos
number
seconds
number
portName
string
project
string
protocol
string
region
required
string
object

Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.

name
string
path
string
ttl
object

Lifetime of the cookie. Structure is documented below.

nanos
number
seconds
number
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

backend
array

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

array

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.

dryRun
boolean
name
string
failover
boolean
group
string
groupRef
object

Reference to a RegionInstanceGroupManager in compute to populate group.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a RegionInstanceGroupManager in compute to populate group.

namespace
string
policy
object

Policies for selection.

resolve
string
maxRate
number
cdnPolicy
object

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

object

The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

array

Names of cookies to include in cache keys.

array

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.

array

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.

cacheMode
string
clientTtl
number
maxTtl
number
array

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.

code
number
object

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

object

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -

object

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.

name
string
path
string
ttl
object

Lifetime of the cookie. Structure is documented below.

nanos
number
seconds
number
array

List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.

dryRun
boolean
name
string
enableCdn
boolean
object

Policy for failovers. Structure is documented below.

array

The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.

array

References to RegionHealthCheck in compute to populate healthChecks.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a list of RegionHealthCheck in compute to populate healthChecks.

namespace
string
policy
object

Policies for selection.

resolve
string
iap
object

Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.

enabled
boolean
object

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

key
required
string
name
required
string
logConfig
object

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.

enable
boolean
array

Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.

network
string
object

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

object

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.

nanos
number
seconds
number
interval
object

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.

nanos
number
seconds
number
portName
string
project
string
protocol
string
object

Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.

name
string
path
string
ttl
object

Lifetime of the cookie. Structure is documented below.

nanos
number
seconds
number
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

kind
required
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

name
required
string
status
object

RegionBackendServiceStatus defines the observed state of RegionBackendService.

object

(No description available)

backend
array

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

array

The set of custom metrics that are used for CUSTOM_METRICS BalancingMode. Structure is documented below.

dryRun
boolean
name
string
failover
boolean
group
string
maxRate
number
cdnPolicy
object

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

object

The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

array

Names of cookies to include in cache keys.

array

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.

array

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.

cacheMode
string
clientTtl
number
maxTtl
number
array

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.

code
number
object

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

object

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field only applies when all of the following are true -

object

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.

name
string
path
string
ttl
object

Lifetime of the cookie. Structure is documented below.

nanos
number
seconds
number
array

List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. Structure is documented below.

dryRun
boolean
name
string
enableCdn
boolean
object

Policy for failovers. Structure is documented below.

array

The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.

iap
object

Settings for enabling Cloud Identity Aware Proxy. If OAuth client is not set, Google-managed OAuth client is used. Structure is documented below.

id
string
logConfig
object

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.

enable
boolean
array

Specifies the fields to include in logging. This field can only be specified if logging is enabled for this backend service.

network
string
object

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

object

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.

nanos
number
seconds
number
interval
object

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.

nanos
number
seconds
number
portName
string
project
string
protocol
string
region
string
selfLink
string
object

Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. Structure is documented below.

name
string
path
string
ttl
object

Lifetime of the cookie. Structure is documented below.

nanos
number
seconds
number
array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string