URL map

Docs > DDSQL Reference > Data Directory > URL map

A URL map in Google Cloud Platform defines how HTTP and HTTPS requests are routed to backend services based on rules such as hostnames, paths, and headers. It is used with load balancers to direct traffic to the correct backend depending on the request’s characteristics. URL maps enable advanced routing, including path-based and host-based routing, redirects, and rewrites, helping optimize traffic distribution and application performance.

gcp.compute_url_map

Fields

ID	Type	Data Type	Description
_key	core	string
ancestors	core	array<string>
creation_timestamp	core	timestamp	Output only. [Output Only] Creation timestamp inRFC3339 text format.
datadog_display_name	core	string
default_custom_error_response_policy	core	json	defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for .example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in .example.com such as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.
default_route_action	core	json	defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
default_service	core	string	The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
default_url_redirect	core	json	When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.
description	core	string	An optional description of this resource. Provide this property when you create the resource.
header_action	core	json	Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect afterheaderAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
host_rules	core	json	The list of host rules to use against the URL.
id	core	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
kind	core	string	Output only. [Output Only] Type of the resource. Always compute#urlMaps for url maps.
labels	core	array<string>
name	core	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.
organization_id	core	string
parent	core	string
path_matchers	core	json	The list of named PathMatchers to use against the URL.
project_id	core	string
project_number	core	string
region	core	string	Output only. [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
region_id	core	string
resource_name	core	string
self_link	core	string	[Output Only] Server-defined URL for the resource.
tags	core	hstore_csv
tests	core	json	The list of expected URL mapping tests. Request to update theUrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
zone_id	core	string