google.cloud.gcp_compute_url_map – Creates a GCP UrlMap

Note

This plugin is part of the google.cloud collection (version 1.0.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_url_map.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
default_route_action
dictionary
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.
cors_policy
dictionary
The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) .
allow_credentials
boolean
    Choices:
  • no
  • yes
Default:
"false"
In response to a preflight request, setting this to true indicates that the actual request can include user credentials.
This translates to the Access-Control-Allow-Credentials header.
allow_headers
list / elements=string
Specifies the content for the Access-Control-Allow-Headers header.
allow_methods
list / elements=string
Specifies the content for the Access-Control-Allow-Methods header.
allow_origin_regexes
list / elements=string
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 an item in allowOrigins or an item in allowOriginRegexes.
allow_origins
list / elements=string
Specifies the list of origins that will be allowed to do CORS requests.
An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled
boolean
    Choices:
  • no
  • yes
Default:
"false"
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
expose_headers
list / elements=string
Specifies the content for the Access-Control-Expose-Headers header.
max_age
integer
Specifies how long results of a preflight request can be cached in seconds.
This translates to the Access-Control-Max-Age header.
fault_injection_policy
dictionary
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.
abort
dictionary
The specification for how client requests are aborted as part of fault injection.
http_status
integer
The HTTP status code used to abort the request.
The value must be between 200 and 599 inclusive.
percentage
string
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.
delay
dictionary
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.
fixed_delay
dictionary
Specifies the value of the fixed delay interval.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds
string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .
percentage
string
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.
request_mirror_policy
dictionary
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.
backend_service
dictionary / required
The full or partial URL to the BackendService resource being mirrored to.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
retry_policy
dictionary
Specifies the retry policy associated with this route.
num_retries
integer
Default:
"1"
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
per_try_timeout
dictionary
Specifies a non-zero timeout per retry attempt.
If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds
string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .
retry_conditions
list / elements=string
Specfies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, * connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code.
This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .
timeout
dictionary
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.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds
string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .
url_rewrite
dictionary
The spec to modify the URL of the request, prior to forwarding the request to the matched service.
host_rewrite
string
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
The value must be between 1 and 255 characters.
path_prefix_rewrite
string
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
The value must be between 1 and 1024 characters.
weighted_backend_services
list / elements=dictionary
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.
backend_service
dictionary
The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
header_action
dictionary
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.
request_headers_to_add
list / elements=dictionary
Headers to add to a matching request prior to forwarding the request to the backendService.
header_name
string
The name of the header to add.
header_value
string
The value of the header to add.
replace
boolean
    Choices:
  • no
  • yes
Default:
"false"
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.
request_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
response_headers_to_add
list / elements=dictionary
Headers to add the response prior to sending the response back to the client.
header_name
string
The name of the header to add.
header_value
string
The value of the header to add.
replace
boolean
    Choices:
  • no
  • yes
Default:
"false"
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.
response_headers_to_remove
list / elements=string
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
integer
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .
The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .
default_service
dictionary
The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this default_service field to "{{ name-of-resource }}"
default_url_redirect
dictionary
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.
host_redirect
string
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
https_redirect
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
path_redirect
string
The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
prefix_redirect
string
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
redirect_response_code
string
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
Some valid choices include: "FOUND", "MOVED_PERMANENTLY_DEFAULT", "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"
strip_query
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
description
string
An optional description of this resource. Provide this property when you create the resource.
env_type
string
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
header_action
dictionary
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.
request_headers_to_add
list / elements=dictionary
Headers to add to a matching request prior to forwarding the request to the backendService.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
request_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
response_headers_to_add
list / elements=dictionary
Headers to add the response prior to sending the response back to the client.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
response_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
host_rules
list / elements=dictionary
The list of HostRules to use against the URL.
description
string
An optional description of this resource. Provide this property when you create the resource.
hosts
list / elements=string / required
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 .
path_matcher
string / required
The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
name
string / required
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
path_matchers
list / elements=dictionary
The list of named PathMatchers to use against the URL.
default_route_action
dictionary
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.
cors_policy
dictionary
The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) .
allow_credentials
boolean
    Choices:
  • no
  • yes
Default:
"false"
In response to a preflight request, setting this to true indicates that the actual request can include user credentials.
This translates to the Access-Control-Allow-Credentials header.
allow_headers
list / elements=string
Specifies the content for the Access-Control-Allow-Headers header.
allow_methods
list / elements=string
Specifies the content for the Access-Control-Allow-Methods header.
allow_origin_regexes
list / elements=string
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 an item in allowOrigins or an item in allowOriginRegexes.
allow_origins
list / elements=string
Specifies the list of origins that will be allowed to do CORS requests.
An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
disabled
boolean
    Choices:
  • no
  • yes
Default:
"false"
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
expose_headers
list / elements=string
Specifies the content for the Access-Control-Expose-Headers header.
max_age
integer
Specifies how long results of a preflight request can be cached in seconds.
This translates to the Access-Control-Max-Age header.
fault_injection_policy
dictionary
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.
abort
dictionary
The specification for how client requests are aborted as part of fault injection.
http_status
integer
The HTTP status code used to abort the request.
The value must be between 200 and 599 inclusive.
percentage
string
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.
delay
dictionary
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.
fixed_delay
dictionary
Specifies the value of the fixed delay interval.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds
string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .
percentage
string
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.
request_mirror_policy
dictionary
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.
backend_service
dictionary / required
The full or partial URL to the BackendService resource being mirrored to.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
retry_policy
dictionary
Specifies the retry policy associated with this route.
num_retries
integer
Default:
"1"
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
per_try_timeout
dictionary
Specifies a non-zero timeout per retry attempt.
If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds
string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .
retry_conditions
list / elements=string
Specfies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, * connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code.
This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .
timeout
dictionary
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.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
seconds
string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .
url_rewrite
dictionary
The spec to modify the URL of the request, prior to forwarding the request to the matched service.
host_rewrite
string
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
The value must be between 1 and 255 characters.
path_prefix_rewrite
string
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
The value must be between 1 and 1024 characters.
weighted_backend_services
list / elements=dictionary
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.
backend_service
dictionary
The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
header_action
dictionary
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.
request_headers_to_add
list / elements=dictionary
Headers to add to a matching request prior to forwarding the request to the backendService.
header_name
string
The name of the header to add.
header_value
string
The value of the header to add.
replace
boolean
    Choices:
  • no
  • yes
Default:
"false"
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.
request_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
response_headers_to_add
list / elements=dictionary
Headers to add the response prior to sending the response back to the client.
header_name
string
The name of the header to add.
header_value
string
The value of the header to add.
replace
boolean
    Choices:
  • no
  • yes
Default:
"false"
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.
response_headers_to_remove
list / elements=string
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
integer
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .
The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .
default_service
dictionary
The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.
Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource defaultService: - compute.backendBuckets.use - compute.backendServices.use .
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this default_service field to "{{ name-of-resource }}"
default_url_redirect
dictionary
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.
host_redirect
string
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
https_redirect
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
path_redirect
string
The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
prefix_redirect
string
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
redirect_response_code
string
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
Some valid choices include: "FOUND", "MOVED_PERMANENTLY_DEFAULT", "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"
strip_query
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.
description
string
An optional description of this resource. Provide this property when you create the resource.
header_action
dictionary
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 .
request_headers_to_add
list / elements=dictionary
Headers to add to a matching request prior to forwarding the request to the backendService.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
request_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
response_headers_to_add
list / elements=dictionary
Headers to add the response prior to sending the response back to the client.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
response_headers_to_remove
list / elements=string
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 / required
The name to which this PathMatcher is referred by the HostRule.
path_rules
list / elements=dictionary
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.
paths
list / elements=string / required
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.
route_action
dictionary
In response to a matching path, 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.
cors_policy
dictionary
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing .
allow_credentials
boolean
    Choices:
  • no
  • yes
Default:
"false"
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false.
allow_headers
list / elements=string
Specifies the content for the Access-Control-Allow-Headers header.
allow_methods
list / elements=string
Specifies the content for the Access-Control-Allow-Methods header.
allow_origin_regexes
list / elements=string
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.
allow_origins
list / elements=string
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 / required
    Choices:
  • no
  • yes
If true, specifies the CORS policy is disabled.
expose_headers
list / elements=string
Specifies the content for the Access-Control-Expose-Headers header.
max_age
integer
Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header.
fault_injection_policy
dictionary
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.
abort
dictionary
The specification for how client requests are aborted as part of fault injection.
http_status
integer / required
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage
string / required
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
delay
dictionary
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.
fixed_delay
dictionary / required
Specifies the value of the fixed delay interval.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
seconds
string / required
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
percentage
string / required
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
request_mirror_policy
dictionary
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.
backend_service
dictionary / required
The BackendService resource being mirrored to.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
retry_policy
dictionary
Specifies the retry policy associated with this route.
num_retries
integer
Specifies the allowed number retries. This number must be > 0.
per_try_timeout
dictionary
Specifies a non-zero timeout per retry attempt.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
seconds
string / required
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
retry_conditions
list / elements=string
Specifies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream: Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .
timeout
dictionary
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.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
seconds
string / required
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
url_rewrite
dictionary
The spec to modify the URL of the request, prior to forwarding the request to the matched service .
host_rewrite
string
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
path_prefix_rewrite
string
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.
weighted_backend_services
list / elements=dictionary
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.
backend_service
dictionary / required
The default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
header_action
dictionary
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.
request_headers_to_add
list / elements=dictionary
Headers to add to a matching request prior to forwarding the request to the backendService.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
request_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
response_headers_to_add
list / elements=dictionary
Headers to add the response prior to sending the response back to the client.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
response_headers_to_remove
list / elements=string
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
integer / required
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .
service
dictionary
The backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this service field to "{{ name-of-resource }}"
url_redirect
dictionary
When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set.
host_redirect
string
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
https_redirect
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, the URL scheme in the redirected request is set to https.
If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
path_redirect
string
The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
The value must be between 1 and 1024 characters.
prefix_redirect
string
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
redirect_response_code
string
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
Some valid choices include: "FOUND", "MOVED_PERMANENTLY_DEFAULT", "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"
strip_query
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.
route_rules
list / elements=dictionary
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.
header_action
dictionary
Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].r outeAction.weightedBackendService.backendServiceWeightAction[].headerAction .
request_headers_to_add
list / elements=dictionary
Headers to add to a matching request prior to forwarding the request to the backendService.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
request_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
response_headers_to_add
list / elements=dictionary
Headers to add the response prior to sending the response back to the client.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
response_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
match_rules
list / elements=dictionary
The rules for determining a match.
full_path_match
string
For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
header_matches
list / elements=dictionary
Specifies a list of header match criteria, all of which must match corresponding headers in the request.
exact_match
string
The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.
header_name
string / required
The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method".
invert_match
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false.
prefix_match
string
The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.
present_match
boolean
    Choices:
  • no
  • yes
A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.
range_match
dictionary
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.
range_end
integer / required
The end of the range (exclusive).
range_start
integer / required
The start of the range (inclusive).
regex_match
string
The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.
Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.
suffix_match
string
The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.
ignore_case
boolean
    Choices:
  • no
  • yes
Default:
"false"
Specifies that prefixMatch and fullPathMatch matches are case sensitive.
Defaults to false.
metadata_filters
list / elements=dictionary
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.
filter_labels
list / elements=dictionary / required
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.
name
string / required
Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
value
string / required
The value of the label must match the specified value. value can have a maximum length of 1024 characters.
filter_match_criteria
string / required
Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.
- MATCH_ALL: All filterLabels must have matching labels in the provided metadata.
Some valid choices include: "MATCH_ALL", "MATCH_ANY"
prefix_match
string
For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
query_parameter_matches
list / elements=dictionary
Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
exact_match
string
The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.
name
string / required
The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.
present_match
boolean
    Choices:
  • no
  • yes
Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set.
regex_match
string
The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.
regex_match
string
For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
priority
integer / required
For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.
You cannot configure two or more routeRules with the same priority.
Priority for each rule must be set to a number between 0 and 2147483647 inclusive.
Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.
route_action
dictionary
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.
cors_policy
dictionary
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing .
allow_credentials
boolean
    Choices:
  • no
  • yes
Default:
"false"
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false.
allow_headers
list / elements=string
Specifies the content for the Access-Control-Allow-Headers header.
allow_methods
list / elements=string
Specifies the content for the Access-Control-Allow-Methods header.
allow_origin_regexes
list / elements=string
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.
allow_origins
list / elements=string
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
    Choices:
  • no
  • yes
Default:
"false"
If true, specifies the CORS policy is disabled.
which indicates that the CORS policy is in effect. Defaults to false.
expose_headers
list / elements=string
Specifies the content for the Access-Control-Expose-Headers header.
max_age
integer
Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header.
fault_injection_policy
dictionary
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.
abort
dictionary
The specification for how client requests are aborted as part of fault injection.
http_status
integer
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
percentage
string
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
delay
dictionary
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.
fixed_delay
dictionary
Specifies the value of the fixed delay interval.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
seconds
string / required
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
percentage
string
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
request_mirror_policy
dictionary
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.
backend_service
dictionary / required
The BackendService resource being mirrored to.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
retry_policy
dictionary
Specifies the retry policy associated with this route.
num_retries
integer / required
Specifies the allowed number retries. This number must be > 0.
per_try_timeout
dictionary
Specifies a non-zero timeout per retry attempt.
If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
seconds
string / required
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
retry_conditions
list / elements=string
Specfies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream: Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .
timeout
dictionary
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.
nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
seconds
string / required
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
url_rewrite
dictionary
The spec to modify the URL of the request, prior to forwarding the request to the matched service .
host_rewrite
string
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
path_prefix_rewrite
string
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.
weighted_backend_services
list / elements=dictionary
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.
backend_service
dictionary / required
The default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this backend_service field to "{{ name-of-resource }}"
header_action
dictionary
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.
request_headers_to_add
list / elements=dictionary
Headers to add to a matching request prior to forwarding the request to the backendService.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
request_headers_to_remove
list / elements=string
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
response_headers_to_add
list / elements=dictionary
Headers to add the response prior to sending the response back to the client.
header_name
string / required
The name of the header.
header_value
string / required
The value of the header to add.
replace
boolean / required
    Choices:
  • no
  • yes
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.
response_headers_to_remove
list / elements=string
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
integer / required
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .
service
dictionary
The backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this service field to "{{ name-of-resource }}"
url_redirect
dictionary
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.
host_redirect
string
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
https_redirect
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys.
Setting this true for TargetHttpsProxy is not permitted. Defaults to false.
path_redirect
string
The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters.
prefix_redirect
string
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
redirect_response_code
string
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.
Some valid choices include: "FOUND", "MOVED_PERMANENTLY_DEFAULT", "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"
strip_query
boolean
    Choices:
  • no
  • yes
Default:
"false"
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. Defaults to false.
project
string
The Google Cloud Platform project to use.
scopes
list / elements=string
Array of scopes to be used
service_account_contents
jsonarg
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email
string
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
path
The path of a Service Account JSON file if serviceaccount is selected as type.
state
string
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
tests
list / elements=dictionary
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.
description
string
Description of this test case.
host
string / required
Host portion of the URL.
path
string / required
Path portion of the URL.
service
dictionary / required
Expected BackendService resource the given URL should be mapped to.
This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_backend_service task and then set this service field to "{{ name-of-resource }}"

Notes

Note

  • API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps

  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.

  • for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a instance group
  google.cloud.gcp_compute_instance_group:
    name: instancegroup-urlmap
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancegroup

- name: create a HTTP health check
  google.cloud.gcp_compute_http_health_check:
    name: httphealthcheck-urlmap
    healthy_threshold: 10
    port: 8080
    timeout_sec: 2
    unhealthy_threshold: 5
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: healthcheck

- name: create a backend service
  google.cloud.gcp_compute_backend_service:
    name: backendservice-urlmap
    backends:
    - group: "{{ instancegroup.selfLink }}"
    health_checks:
    - "{{ healthcheck.selfLink }}"
    enable_cdn: 'true'
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: backendservice

- name: create a URL map
  google.cloud.gcp_compute_url_map:
    name: test_object
    default_service: "{{ backendservice }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
creationTimestamp
string
success
Creation timestamp in RFC3339 text format.

defaultRouteAction
complex
success
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.

 
corsPolicy
complex
success
The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) .

   
allowCredentials
boolean
success
In response to a preflight request, setting this to true indicates that the actual request can include user credentials.
This translates to the Access-Control-Allow-Credentials header.

   
allowHeaders
list / elements=string
success
Specifies the content for the Access-Control-Allow-Headers header.

   
allowMethods
list / elements=string
success
Specifies the content for the Access-Control-Allow-Methods header.

   
allowOriginRegexes
list / elements=string
success
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 an item in allowOrigins or an item in allowOriginRegexes.

   
allowOrigins
list / elements=string
success
Specifies the list of origins that will be allowed to do CORS requests.
An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

   
disabled
boolean
success
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.

   
exposeHeaders
list / elements=string
success
Specifies the content for the Access-Control-Expose-Headers header.

   
maxAge
integer
success
Specifies how long results of a preflight request can be cached in seconds.
This translates to the Access-Control-Max-Age header.

 
faultInjectionPolicy
complex
success
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.

   
abort
complex
success
The specification for how client requests are aborted as part of fault injection.

     
httpStatus
integer
success
The HTTP status code used to abort the request.
The value must be between 200 and 599 inclusive.

     
percentage
string
success
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.

   
delay
complex
success
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

     
fixedDelay
complex
success
Specifies the value of the fixed delay interval.

       
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

       
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .

     
percentage
string
success
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.

 
requestMirrorPolicy
complex
success
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.

   
backendService
dictionary
success
The full or partial URL to the BackendService resource being mirrored to.

 
retryPolicy
complex
success
Specifies the retry policy associated with this route.

   
numRetries
integer
success
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

   
perTryTimeout
complex
success
Specifies a non-zero timeout per retry attempt.
If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

     
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

     
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .

   
retryConditions
list / elements=string
success
Specfies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, * connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code.
This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .

 
timeout
complex
success
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.

   
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

   
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .

 
urlRewrite
complex
success
The spec to modify the URL of the request, prior to forwarding the request to the matched service.

   
hostRewrite
string
success
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
The value must be between 1 and 255 characters.

   
pathPrefixRewrite
string
success
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
The value must be between 1 and 1024 characters.

 
weightedBackendServices
complex
success
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.

   
backendService
dictionary
success
The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

   
headerAction
complex
success
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.

     
requestHeadersToAdd
complex
success
Headers to add to a matching request prior to forwarding the request to the backendService.

       
headerName
string
success
The name of the header to add.

       
headerValue
string
success
The value of the header to add.

       
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.

     
requestHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

     
responseHeadersToAdd
complex
success
Headers to add the response prior to sending the response back to the client.

       
headerName
string
success
The name of the header to add.

       
headerValue
string
success
The value of the header to add.

       
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.

     
responseHeadersToRemove
list / elements=string
success
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
integer
success
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .
The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .

defaultService
dictionary
success
The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

defaultUrlRedirect
complex
success
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.

 
hostRedirect
string
success
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

 
httpsRedirect
boolean
success
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

 
pathRedirect
string
success
The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

 
prefixRedirect
string
success
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

 
redirectResponseCode
string
success
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

 
stripQuery
boolean
success
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.

description
string
success
An optional description of this resource. Provide this property when you create the resource.

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

headerAction
complex
success
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.

 
requestHeadersToAdd
complex
success
Headers to add to a matching request prior to forwarding the request to the backendService.

   
headerName
string
success
The name of the header.

   
headerValue
string
success
The value of the header to add.

   
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

 
requestHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

 
responseHeadersToAdd
complex
success
Headers to add the response prior to sending the response back to the client.

   
headerName
string
success
The name of the header.

   
headerValue
string
success
The value of the header to add.

   
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

 
responseHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

hostRules
complex
success
The list of HostRules to use against the URL.

 
description
string
success
An optional description of this resource. Provide this property when you create the resource.

 
hosts
list / elements=string
success
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 .

 
pathMatcher
string
success
The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

id
integer
success
The unique identifier for the resource.

name
string
success
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

pathMatchers
complex
success
The list of named PathMatchers to use against the URL.

 
defaultRouteAction
complex
success
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.

   
corsPolicy
complex
success
The specification for allowing client side cross-origin requests. Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/) .

     
allowCredentials
boolean
success
In response to a preflight request, setting this to true indicates that the actual request can include user credentials.
This translates to the Access-Control-Allow-Credentials header.

     
allowHeaders
list / elements=string
success
Specifies the content for the Access-Control-Allow-Headers header.

     
allowMethods
list / elements=string
success
Specifies the content for the Access-Control-Allow-Methods header.

     
allowOriginRegexes
list / elements=string
success
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 an item in allowOrigins or an item in allowOriginRegexes.

     
allowOrigins
list / elements=string
success
Specifies the list of origins that will be allowed to do CORS requests.
An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

     
disabled
boolean
success
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.

     
exposeHeaders
list / elements=string
success
Specifies the content for the Access-Control-Expose-Headers header.

     
maxAge
integer
success
Specifies how long results of a preflight request can be cached in seconds.
This translates to the Access-Control-Max-Age header.

   
faultInjectionPolicy
complex
success
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.

     
abort
complex
success
The specification for how client requests are aborted as part of fault injection.

       
httpStatus
integer
success
The HTTP status code used to abort the request.
The value must be between 200 and 599 inclusive.

       
percentage
string
success
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.

     
delay
complex
success
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

       
fixedDelay
complex
success
Specifies the value of the fixed delay interval.

         
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

         
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .

       
percentage
string
success
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.
The value must be between 0.0 and 100.0 inclusive.

   
requestMirrorPolicy
complex
success
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.

     
backendService
dictionary
success
The full or partial URL to the BackendService resource being mirrored to.

   
retryPolicy
complex
success
Specifies the retry policy associated with this route.

     
numRetries
integer
success
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

     
perTryTimeout
complex
success
Specifies a non-zero timeout per retry attempt.
If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

       
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

       
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .

     
retryConditions
list / elements=string
success
Specfies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, * connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code.
This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .

   
timeout
complex
success
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.

     
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

     
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.
Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years .

   
urlRewrite
complex
success
The spec to modify the URL of the request, prior to forwarding the request to the matched service.

     
hostRewrite
string
success
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
The value must be between 1 and 255 characters.

     
pathPrefixRewrite
string
success
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
The value must be between 1 and 1024 characters.

   
weightedBackendServices
complex
success
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.

     
backendService
dictionary
success
The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

     
headerAction
complex
success
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.

       
requestHeadersToAdd
complex
success
Headers to add to a matching request prior to forwarding the request to the backendService.

         
headerName
string
success
The name of the header to add.

         
headerValue
string
success
The value of the header to add.

         
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.

       
requestHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

       
responseHeadersToAdd
complex
success
Headers to add the response prior to sending the response back to the client.

         
headerName
string
success
The name of the header to add.

         
headerValue
string
success
The value of the header to add.

         
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header.
If true, headerValue is set for the header, discarding any values that were set for that header.

       
responseHeadersToRemove
list / elements=string
success
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
integer
success
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .
The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .

 
defaultService
dictionary
success
The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.
Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource defaultService: - compute.backendBuckets.use - compute.backendServices.use .

 
defaultUrlRedirect
complex
success
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.

   
hostRedirect
string
success
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

   
httpsRedirect
boolean
success
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

   
pathRedirect
string
success
The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

   
prefixRedirect
string
success
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

   
redirectResponseCode
string
success
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

   
stripQuery
boolean
success
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

 
description
string
success
An optional description of this resource. Provide this property when you create the resource.

 
headerAction
complex
success
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 .

   
requestHeadersToAdd
complex
success
Headers to add to a matching request prior to forwarding the request to the backendService.

     
headerName
string
success
The name of the header.

     
headerValue
string
success
The value of the header to add.

     
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

   
requestHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

   
responseHeadersToAdd
complex
success
Headers to add the response prior to sending the response back to the client.

     
headerName
string
success
The name of the header.

     
headerValue
string
success
The value of the header to add.

     
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

   
responseHeadersToRemove
list / elements=string
success
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
success
The name to which this PathMatcher is referred by the HostRule.

 
pathRules
complex
success
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.

   
paths
list / elements=string
success
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.

   
routeAction
complex
success
In response to a matching path, 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.

     
corsPolicy
complex
success
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing .

       
allowCredentials
boolean
success
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false.

       
allowHeaders
list / elements=string
success
Specifies the content for the Access-Control-Allow-Headers header.

       
allowMethods
list / elements=string
success
Specifies the content for the Access-Control-Allow-Methods header.

       
allowOriginRegexes
list / elements=string
success
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.

       
allowOrigins
list / elements=string
success
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
success
If true, specifies the CORS policy is disabled.

       
exposeHeaders
list / elements=string
success
Specifies the content for the Access-Control-Expose-Headers header.

       
maxAge
integer
success
Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header.

     
faultInjectionPolicy
complex
success
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.

       
abort
complex
success
The specification for how client requests are aborted as part of fault injection.

         
httpStatus
integer
success
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

         
percentage
string
success
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

       
delay
complex
success
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

         
fixedDelay
complex
success
Specifies the value of the fixed delay interval.

           
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

           
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

         
percentage
string
success
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

     
requestMirrorPolicy
complex
success
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.

       
backendService
dictionary
success
The BackendService resource being mirrored to.

     
retryPolicy
complex
success
Specifies the retry policy associated with this route.

       
numRetries
integer
success
Specifies the allowed number retries. This number must be > 0.

       
perTryTimeout
complex
success
Specifies a non-zero timeout per retry attempt.

         
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

         
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

       
retryConditions
list / elements=string
success
Specifies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream: Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .

     
timeout
complex
success
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.

       
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

       
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

     
urlRewrite
complex
success
The spec to modify the URL of the request, prior to forwarding the request to the matched service .

       
hostRewrite
string
success
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

       
pathPrefixRewrite
string
success
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

     
weightedBackendServices
complex
success
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.

       
backendService
dictionary
success
The default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

       
headerAction
complex
success
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.

         
requestHeadersToAdd
complex
success
Headers to add to a matching request prior to forwarding the request to the backendService.

           
headerName
string
success
The name of the header.

           
headerValue
string
success
The value of the header to add.

           
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

         
requestHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

         
responseHeadersToAdd
complex
success
Headers to add the response prior to sending the response back to the client.

           
headerName
string
success
The name of the header.

           
headerValue
string
success
The value of the header to add.

           
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

         
responseHeadersToRemove
list / elements=string
success
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
integer
success
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .

   
service
dictionary
success
The backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

   
urlRedirect
complex
success
When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set.

     
hostRedirect
string
success
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

     
httpsRedirect
boolean
success
If set to true, the URL scheme in the redirected request is set to https.
If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

     
pathRedirect
string
success
The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
The value must be between 1 and 1024 characters.

     
prefixRedirect
string
success
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

     
redirectResponseCode
string
success
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

     
stripQuery
boolean
success
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

 
routeRules
complex
success
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.

   
headerAction
complex
success
Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].r outeAction.weightedBackendService.backendServiceWeightAction[].headerAction .

     
requestHeadersToAdd
complex
success
Headers to add to a matching request prior to forwarding the request to the backendService.

       
headerName
string
success
The name of the header.

       
headerValue
string
success
The value of the header to add.

       
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

     
requestHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

     
responseHeadersToAdd
complex
success
Headers to add the response prior to sending the response back to the client.

       
headerName
string
success
The name of the header.

       
headerValue
string
success
The value of the header to add.

       
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

     
responseHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

   
matchRules
complex
success
The rules for determining a match.

     
fullPathMatch
string
success
For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

     
headerMatches
complex
success
Specifies a list of header match criteria, all of which must match corresponding headers in the request.

       
exactMatch
string
success
The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

       
headerName
string
success
The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method".

       
invertMatch
boolean
success
If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. Defaults to false.

       
prefixMatch
string
success
The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

       
presentMatch
boolean
success
A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

       
rangeMatch
complex
success
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.

         
rangeEnd
integer
success
The end of the range (exclusive).

         
rangeStart
integer
success
The start of the range (inclusive).

       
regexMatch
string
success
The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.
Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

       
suffixMatch
string
success
The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

     
ignoreCase
boolean
success
Specifies that prefixMatch and fullPathMatch matches are case sensitive.
Defaults to false.

     
metadataFilters
complex
success
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.

       
filterLabels
complex
success
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.

         
name
string
success
Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

         
value
string
success
The value of the label must match the specified value. value can have a maximum length of 1024 characters.

       
filterMatchCriteria
string
success
Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.
- MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

     
prefixMatch
string
success
For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

     
queryParameterMatches
complex
success
Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

       
exactMatch
string
success
The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set.

       
name
string
success
The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

       
presentMatch
boolean
success
Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set.

       
regexMatch
string
success
The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch and regexMatch must be set.

     
regexMatch
string
success
For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

   
priority
integer
success
For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.
You cannot configure two or more routeRules with the same priority.
Priority for each rule must be set to a number between 0 and 2147483647 inclusive.
Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

   
routeAction
complex
success
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.

     
corsPolicy
complex
success
The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing .

       
allowCredentials
boolean
success
In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false.

       
allowHeaders
list / elements=string
success
Specifies the content for the Access-Control-Allow-Headers header.

       
allowMethods
list / elements=string
success
Specifies the content for the Access-Control-Allow-Methods header.

       
allowOriginRegexes
list / elements=string
success
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.

       
allowOrigins
list / elements=string
success
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
success
If true, specifies the CORS policy is disabled.
which indicates that the CORS policy is in effect. Defaults to false.

       
exposeHeaders
list / elements=string
success
Specifies the content for the Access-Control-Expose-Headers header.

       
maxAge
integer
success
Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header.

     
faultInjectionPolicy
complex
success
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.

       
abort
complex
success
The specification for how client requests are aborted as part of fault injection.

         
httpStatus
integer
success
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

         
percentage
string
success
The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

       
delay
complex
success
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

         
fixedDelay
complex
success
Specifies the value of the fixed delay interval.

           
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

           
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

         
percentage
string
success
The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

     
requestMirrorPolicy
complex
success
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.

       
backendService
dictionary
success
The BackendService resource being mirrored to.

     
retryPolicy
complex
success
Specifies the retry policy associated with this route.

       
numRetries
integer
success
Specifies the allowed number retries. This number must be > 0.

       
perTryTimeout
complex
success
Specifies a non-zero timeout per retry attempt.
If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

         
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

         
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

       
retryConditions
list / elements=string
success
Specfies one or more conditions when this retry rule applies. Valid values are: * 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.
* gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
* connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
* retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
Currently the only retriable error supported is 409.
* refused-stream: Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
* cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled * deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded * resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted * unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable .

     
timeout
complex
success
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.

       
nanos
integer
success
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

       
seconds
string
success
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

     
urlRewrite
complex
success
The spec to modify the URL of the request, prior to forwarding the request to the matched service .

       
hostRewrite
string
success
Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

       
pathPrefixRewrite
string
success
Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

     
weightedBackendServices
complex
success
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.

       
backendService
dictionary
success
The default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

       
headerAction
complex
success
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.

         
requestHeadersToAdd
complex
success
Headers to add to a matching request prior to forwarding the request to the backendService.

           
headerName
string
success
The name of the header.

           
headerValue
string
success
The value of the header to add.

           
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

         
requestHeadersToRemove
list / elements=string
success
A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

         
responseHeadersToAdd
complex
success
Headers to add the response prior to sending the response back to the client.

           
headerName
string
success
The name of the header.

           
headerValue
string
success
The value of the header to add.

           
replace
boolean
success
If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

         
responseHeadersToRemove
list / elements=string
success
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
integer
success
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.
The value must be between 0 and 1000 .

   
service
dictionary
success
The backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

   
urlRedirect
complex
success
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.

     
hostRedirect
string
success
The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

     
httpsRedirect
boolean
success
If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys.
Setting this true for TargetHttpsProxy is not permitted. Defaults to false.

     
pathRedirect
string
success
The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters.

     
prefixRedirect
string
success
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

     
redirectResponseCode
string
success
The HTTP Status code to use for this RedirectAction. Supported values are: * MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.
* FOUND, which corresponds to 302.
* SEE_OTHER which corresponds to 303.
* TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.
* PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

     
stripQuery
boolean
success
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. Defaults to false.

tests
complex
success
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.

 
description
string
success
Description of this test case.

 
host
string
success
Host portion of the URL.

 
path
string
success
Path portion of the URL.

 
service
dictionary
success
Expected BackendService resource the given URL should be mapped to.



Authors

  • Google Inc. (@googlecloudplatform)