Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-gcp.Go to Latest
upbound/provider-gcp@v0.41.2
URLMap
compute.gcp.upbound.io
URLMap
upbound/provider-gcp@v0.41.2compute.gcp.upbound.io

URLMap is the Schema for the URLMaps API. UrlMaps are used to route requests to a backend service based on rules that you define for the host and path of an incoming URL.

Type

CRD

Group

compute.gcp.upbound.io

Version

v1beta1

apiVersion: compute.gcp.upbound.io/v1beta1

kind: URLMap

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

URLMapSpec defines the desired state of URLMap

forProvider
requiredobject
requiredobject

No description provided.

array

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
object

Reference to a BackendBucket in compute to populate defaultService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate defaultService.

policy
object
object

Policies for selection.

resolve
string
array

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

array

The list of HostRules to use against the URL. Structure is documented below.

hosts
array
array

The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

array

The list of named PathMatchers to use against the URL. Structure is documented below.

array

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
object

Reference to a BackendBucket in compute to populate defaultService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate defaultService.

policy
object
object

Policies for selection.

resolve
string
array

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

name
string
array

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below.

paths
array
array

The list of path patterns to match. Each must start with / and the only place a

  • is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
array

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

object

Reference to a BackendService in compute to populate backendService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendService in compute to populate backendService.

policy
object
object

Policies for selection.

resolve
string
array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

object

Reference to a BackendService in compute to populate backendService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendService in compute to populate backendService.

policy
object
object

Policies for selection.

resolve
string
array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
service
string
object

Reference to a BackendBucket in compute to populate service.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate service.

policy
object
object

Policies for selection.

resolve
string
array

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

array

The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

array

The rules for determining a match. Structure is documented below.

array

Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below.

array

The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Structure is documented below.

rangeEnd
number
ignoreCase
boolean
array

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

array

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.

name
string
value
string
array

Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below.

name
string
priority
number
array

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
service
string
object

Reference to a BackendService in compute to populate service.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendService in compute to populate service.

policy
object
object

Policies for selection.

resolve
string
array

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

project
string
test
array
array

The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

host
string
path
string
service
string
object

Reference to a BackendBucket in compute to populate service.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate service.

policy
object
object

Policies for selection.

resolve
string
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.

array

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
object

Reference to a BackendBucket in compute to populate defaultService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate defaultService.

policy
object
object

Policies for selection.

resolve
string
array

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

array

The list of HostRules to use against the URL. Structure is documented below.

hosts
array
array

The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

array

The list of named PathMatchers to use against the URL. Structure is documented below.

array

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
object

Reference to a BackendBucket in compute to populate defaultService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate defaultService.

policy
object
object

Policies for selection.

resolve
string
array

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

name
string
array

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below.

paths
array
array

The list of path patterns to match. Each must start with / and the only place a

  • is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
array

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

object

Reference to a BackendService in compute to populate backendService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendService in compute to populate backendService.

policy
object
object

Policies for selection.

resolve
string
array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

object

Reference to a BackendService in compute to populate backendService.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendService in compute to populate backendService.

policy
object
object

Policies for selection.

resolve
string
array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
service
string
object

Reference to a BackendBucket in compute to populate service.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate service.

policy
object
object

Policies for selection.

resolve
string
array

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

array

The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

array

The rules for determining a match. Structure is documented below.

array

Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below.

array

The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Structure is documented below.

rangeEnd
number
ignoreCase
boolean
array

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

array

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.

name
string
value
string
array

Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below.

name
string
priority
number
array

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
service
string
object

Reference to a BackendService in compute to populate service.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendService in compute to populate service.

policy
object
object

Policies for selection.

resolve
string
array

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

project
string
test
array
array

The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

host
string
path
string
service
string
object

Reference to a BackendBucket in compute to populate service.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a BackendBucket in compute to populate service.

policy
object
object

Policies for selection.

resolve
string
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. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. 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.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config 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.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
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. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

URLMapStatus defines the observed state of URLMap.

object

No description provided.

array

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
array

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

array

The list of HostRules to use against the URL. Structure is documented below.

hosts
array
array

The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

id
string
mapId
number
array

The list of named PathMatchers to use against the URL. Structure is documented below.

array

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
array

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

name
string
array

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below.

paths
array
array

The list of path patterns to match. Each must start with / and the only place a

  • is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
array

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex.

array

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex.

disabled
boolean
array

Specifies the content for the Access-Control-Expose-Headers header.

maxAge
number
array

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

abort
array
array

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

delay
array
array

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

array

Specifies the value of the fixed delay interval. Structure is documented below.

nanos
number
seconds
string
array

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

array

Specifies the retry policy associated with this route. Structure is documented below.

array

Specifies a non-zero timeout per retry attempt. Structure is documented below.

nanos
number
seconds
string
array

Specifies one or more conditions when this retry rule applies. Valid values are:

timeout
array
array

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

nanos
number
seconds
string
array

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

array

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

weight
number
service
string
array

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

array

The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

array

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

array

Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

array

Headers to add the response prior to sending the response back to the client. Structure is documented below.

replace
boolean
array

A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

array

The rules for determining a match. Structure is documented below.

array

Specifies a list of header match criteria, all of which must match corresponding headers in the request. Structure is documented below.

array

The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Structure is documented below.

rangeEnd
number
ignoreCase
boolean
array

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

array

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.

name
string
value
string
array

Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Structure is documented below.

name
string
priority
number
array

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.

array

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

array

Specifies the content for the Access-Control-Allow-Headers header.

array

Specifies the content for the Access-Control-Allow-Methods header.

array

Specifies the regular expression patterns that match allowed