RegionUrlMap

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.

Create a RegionUrlMap Resource

def RegionUrlMap(resource_name, opts=None, default_service=None, default_url_redirect=None, description=None, host_rules=None, name=None, path_matchers=None, project=None, region=None, tests=None, __props__=None);
func NewRegionUrlMap(ctx *Context, name string, args *RegionUrlMapArgs, opts ...ResourceOption) (*RegionUrlMap, error)
public RegionUrlMap(string name, RegionUrlMapArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RegionUrlMapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RegionUrlMapArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RegionUrlMapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

RegionUrlMap Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The RegionUrlMap resource accepts the following input properties:

DefaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

DefaultUrlRedirect RegionUrlMapDefaultUrlRedirectArgs

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

Description string

Description of this test case.

HostRules List<RegionUrlMapHostRuleArgs>

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

Name string

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.

PathMatchers List<RegionUrlMapPathMatcherArgs>

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the url map should reside. If it is not provided, the provider region is used.

Tests List<RegionUrlMapTestArgs>

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

DefaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

DefaultUrlRedirect RegionUrlMapDefaultUrlRedirect

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

Description string

Description of this test case.

HostRules []RegionUrlMapHostRule

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

Name string

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.

PathMatchers []RegionUrlMapPathMatcher

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the url map should reside. If it is not provided, the provider region is used.

Tests []RegionUrlMapTest

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

defaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

defaultUrlRedirect RegionUrlMapDefaultUrlRedirect

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

description string

Description of this test case.

hostRules RegionUrlMapHostRule[]

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

name string

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.

pathMatchers RegionUrlMapPathMatcher[]

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The Region in which the url map should reside. If it is not provided, the provider region is used.

tests RegionUrlMapTest[]

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

default_service str

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

default_url_redirect Dict[RegionUrlMapDefaultUrlRedirect]

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

description str

Description of this test case.

host_rules List[RegionUrlMapHostRule]

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

name str

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.

path_matchers List[RegionUrlMapPathMatcher]

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The Region in which the url map should reside. If it is not provided, the provider region is used.

tests List[RegionUrlMapTest]

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the RegionUrlMap resource produces the following output properties:

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

Id string
The provider-assigned unique ID for this managed resource.
MapId int

The unique identifier for the resource.

SelfLink string

The URI of the created resource.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

Id string
The provider-assigned unique ID for this managed resource.
MapId int

The unique identifier for the resource.

SelfLink string

The URI of the created resource.

creationTimestamp string

Creation timestamp in RFC3339 text format.

fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

id string
The provider-assigned unique ID for this managed resource.
mapId number

The unique identifier for the resource.

selfLink string

The URI of the created resource.

creation_timestamp str

Creation timestamp in RFC3339 text format.

fingerprint str

Fingerprint of this resource. This field is used internally during updates of this resource.

id str
The provider-assigned unique ID for this managed resource.
map_id float

The unique identifier for the resource.

self_link str

The URI of the created resource.

Look up an Existing RegionUrlMap Resource

Get an existing RegionUrlMap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RegionUrlMapState, opts?: CustomResourceOptions): RegionUrlMap
static get(resource_name, id, opts=None, creation_timestamp=None, default_service=None, default_url_redirect=None, description=None, fingerprint=None, host_rules=None, map_id=None, name=None, path_matchers=None, project=None, region=None, self_link=None, tests=None, __props__=None);
func GetRegionUrlMap(ctx *Context, name string, id IDInput, state *RegionUrlMapState, opts ...ResourceOption) (*RegionUrlMap, error)
public static RegionUrlMap Get(string name, Input<string> id, RegionUrlMapState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

CreationTimestamp string

Creation timestamp in RFC3339 text format.

DefaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

DefaultUrlRedirect RegionUrlMapDefaultUrlRedirectArgs

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

Description string

Description of this test case.

Fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

HostRules List<RegionUrlMapHostRuleArgs>

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

MapId int

The unique identifier for the resource.

Name string

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.

PathMatchers List<RegionUrlMapPathMatcherArgs>

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the url map should reside. If it is not provided, the provider region is used.

SelfLink string

The URI of the created resource.

Tests List<RegionUrlMapTestArgs>

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

DefaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

DefaultUrlRedirect RegionUrlMapDefaultUrlRedirect

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

Description string

Description of this test case.

Fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

HostRules []RegionUrlMapHostRule

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

MapId int

The unique identifier for the resource.

Name string

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.

PathMatchers []RegionUrlMapPathMatcher

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the url map should reside. If it is not provided, the provider region is used.

SelfLink string

The URI of the created resource.

Tests []RegionUrlMapTest

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

creationTimestamp string

Creation timestamp in RFC3339 text format.

defaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

defaultUrlRedirect RegionUrlMapDefaultUrlRedirect

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

description string

Description of this test case.

fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

hostRules RegionUrlMapHostRule[]

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

mapId number

The unique identifier for the resource.

name string

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.

pathMatchers RegionUrlMapPathMatcher[]

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The Region in which the url map should reside. If it is not provided, the provider region is used.

selfLink string

The URI of the created resource.

tests RegionUrlMapTest[]

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

creation_timestamp str

Creation timestamp in RFC3339 text format.

default_service str

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

default_url_redirect Dict[RegionUrlMapDefaultUrlRedirect]

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

description str

Description of this test case.

fingerprint str

Fingerprint of this resource. This field is used internally during updates of this resource.

host_rules List[RegionUrlMapHostRule]

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

map_id float

The unique identifier for the resource.

name str

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.

path_matchers List[RegionUrlMapPathMatcher]

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The Region in which the url map should reside. If it is not provided, the provider region is used.

self_link str

The URI of the created resource.

tests List[RegionUrlMapTest]

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

Supporting Types

RegionUrlMapDefaultUrlRedirect

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

StripQuery bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

HttpsRedirect bool

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

HttpsRedirect bool

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

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

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

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

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

httpsRedirect boolean

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

hostRedirect str

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 bool

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 str

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 str

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 str

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.

RegionUrlMapHostRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Hosts List<string>

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

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

Description string

Description of this test case.

Hosts []string

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

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

Description string

Description of this test case.

hosts string[]

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

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

description string

Description of this test case.

hosts List[str]

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 str

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

description str

Description of this test case.

RegionUrlMapPathMatcher

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

DefaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

Name string

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.

DefaultUrlRedirect RegionUrlMapPathMatcherDefaultUrlRedirectArgs

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

Description string

Description of this test case.

PathRules List<RegionUrlMapPathMatcherPathRuleArgs>

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

RouteRules List<RegionUrlMapPathMatcherRouteRuleArgs>

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

DefaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

Name string

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.

DefaultUrlRedirect RegionUrlMapPathMatcherDefaultUrlRedirect

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

Description string

Description of this test case.

PathRules []RegionUrlMapPathMatcherPathRule

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

RouteRules []RegionUrlMapPathMatcherRouteRule

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

defaultService string

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

name string

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.

defaultUrlRedirect RegionUrlMapPathMatcherDefaultUrlRedirect

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

description string

Description of this test case.

pathRules RegionUrlMapPathMatcherPathRule[]

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

routeRules RegionUrlMapPathMatcherRouteRule[]

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

default_service str

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

name str

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.

default_url_redirect Dict[RegionUrlMapPathMatcherDefaultUrlRedirect]

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

description str

Description of this test case.

pathRules List[RegionUrlMapPathMatcherPathRule]

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

routeRules List[RegionUrlMapPathMatcherRouteRule]

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

RegionUrlMapPathMatcherDefaultUrlRedirect

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

StripQuery bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

HttpsRedirect bool

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

HttpsRedirect bool

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

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

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

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

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

httpsRedirect boolean

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

hostRedirect str

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 bool

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 str

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 str

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 str

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.

RegionUrlMapPathMatcherPathRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Paths List<string>

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 RegionUrlMapPathMatcherPathRuleRouteActionArgs

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. Structure is documented below.

Service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

UrlRedirect RegionUrlMapPathMatcherPathRuleUrlRedirectArgs

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. Structure is documented below.

Paths []string

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 RegionUrlMapPathMatcherPathRuleRouteAction

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. Structure is documented below.

Service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

UrlRedirect RegionUrlMapPathMatcherPathRuleUrlRedirect

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. Structure is documented below.

paths string[]

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 RegionUrlMapPathMatcherPathRuleRouteAction

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. Structure is documented below.

service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

urlRedirect RegionUrlMapPathMatcherPathRuleUrlRedirect

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. Structure is documented below.

paths List[str]

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 Dict[RegionUrlMapPathMatcherPathRuleRouteAction]

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. Structure is documented below.

service str

A reference to expected RegionBackendService resource the given URL should be mapped to.

urlRedirect Dict[RegionUrlMapPathMatcherPathRuleUrlRedirect]

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. Structure is documented below.

RegionUrlMapPathMatcherPathRuleRouteAction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CorsPolicy RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicyArgs

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

FaultInjectionPolicy RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyArgs

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

RequestMirrorPolicy RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicyArgs

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

RetryPolicy RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyArgs

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

Timeout RegionUrlMapPathMatcherPathRuleRouteActionTimeoutArgs

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

UrlRewrite RegionUrlMapPathMatcherPathRuleRouteActionUrlRewriteArgs

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

WeightedBackendServices List<RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceArgs>

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

CorsPolicy RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicy

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

FaultInjectionPolicy RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy

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

RequestMirrorPolicy RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy

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

RetryPolicy RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicy

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

Timeout RegionUrlMapPathMatcherPathRuleRouteActionTimeout

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

UrlRewrite RegionUrlMapPathMatcherPathRuleRouteActionUrlRewrite

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

WeightedBackendServices []RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendService

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

corsPolicy RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicy

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

faultInjectionPolicy RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy

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

requestMirrorPolicy RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy

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

retryPolicy RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicy

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

timeout RegionUrlMapPathMatcherPathRuleRouteActionTimeout

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

urlRewrite RegionUrlMapPathMatcherPathRuleRouteActionUrlRewrite

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

weightedBackendServices RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendService[]

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

corsPolicy Dict[RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicy]

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

faultInjectionPolicy Dict[RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy]

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

requestMirrorPolicy Dict[RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy]

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

retryPolicy Dict[RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicy]

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

timeout Dict[RegionUrlMapPathMatcherPathRuleRouteActionTimeout]

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

urlRewrite Dict[RegionUrlMapPathMatcherPathRuleRouteActionUrlRewrite]

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

weightedBackendServices List[RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendService]

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

RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Disabled bool

If true, specifies the CORS policy is disabled.

AllowCredentials bool

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

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

AllowMethods List<string>

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

AllowOriginRegexes List<string>

Specifies the regualar 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<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.

ExposeHeaders List<string>

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

MaxAge int

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

Disabled bool

If true, specifies the CORS policy is disabled.

AllowCredentials bool

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 []string

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

AllowMethods []string

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

AllowOriginRegexes []string

Specifies the regualar 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 []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.

ExposeHeaders []string

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

MaxAge int

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

disabled boolean

If true, specifies the CORS policy is disabled.

allowCredentials boolean

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 string[]

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

allowMethods string[]

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

allowOriginRegexes string[]

Specifies the regualar 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 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.

exposeHeaders string[]

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

maxAge number

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

disabled bool

If true, specifies the CORS policy is disabled.

allowCredentials bool

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[str]

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

allowMethods List[str]

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

allowOriginRegexes List[str]

Specifies the regualar 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[str]

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.

exposeHeaders List[str]

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

maxAge float

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

RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Abort RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbortArgs

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

Delay RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayArgs

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

Abort RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort

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

Delay RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay

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

abort RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort

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

delay RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay

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

abort Dict[RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort]

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

delay Dict[RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay]

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

RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HttpStatus int

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

Percentage double

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.

HttpStatus int

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

Percentage float64

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.

httpStatus number

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

percentage number

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.

httpStatus float

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

percentage float

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.

RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

FixedDelay RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelayArgs

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

Percentage double

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.

FixedDelay RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay

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

Percentage float64

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.

fixedDelay RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay

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

percentage number

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.

fixedDelay Dict[RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay]

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

percentage float

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.

RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Seconds string

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

Nanos int

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.

Nanos int

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.

nanos number

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 str

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

nanos float

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.

RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

BackendService string

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

BackendService string

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

backendService string

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

backend_service str

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

RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

NumRetries int

Specifies the allowed number retries. This number must be > 0.

PerTryTimeout RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeoutArgs

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

RetryConditions List<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

NumRetries int

Specifies the allowed number retries. This number must be > 0.

PerTryTimeout RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout

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

RetryConditions []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

numRetries number

Specifies the allowed number retries. This number must be > 0.

perTryTimeout RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout

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

retryConditions 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

numRetries float

Specifies the allowed number retries. This number must be > 0.

perTryTimeout Dict[RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout]

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

retryConditions List[str]

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

RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Seconds string

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

Nanos int

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.

Nanos int

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.

nanos number

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 str

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

nanos float

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.

RegionUrlMapPathMatcherPathRuleRouteActionTimeout

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Seconds string

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

Nanos int

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.

Nanos int

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.

nanos number

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 str

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

nanos float

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.

RegionUrlMapPathMatcherPathRuleRouteActionUrlRewrite

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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

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

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

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

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

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

hostRewrite str

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 str

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.

RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendService

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

BackendService string

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

Weight int

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

HeaderAction RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionArgs

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

BackendService string

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

Weight int

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

HeaderAction RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction

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

backendService string

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

weight number

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

headerAction RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction

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

backend_service str

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

weight float

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

header_action Dict[RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction]

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

RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

RequestHeadersToAdds List<RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs>

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

RequestHeadersToRemoves List<string>

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

ResponseHeadersToAdds List<RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs>

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

ResponseHeadersToRemoves List<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.

RequestHeadersToAdds []RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

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

RequestHeadersToRemoves []string

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

ResponseHeadersToAdds []RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

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

ResponseHeadersToRemoves []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.

requestHeadersToAdds RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd[]

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

requestHeadersToRemoves string[]

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

responseHeadersToAdds RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd[]

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

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

requestHeadersToAdds List[RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd]

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

requestHeadersToRemoves List[str]

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

responseHeadersToAdds List[RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd]

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

responseHeadersToRemoves List[str]

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

RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

headerName string

The name of the header.

headerValue string

The value of the header to add.

replace boolean

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.

headerName str

The name of the header.

headerValue str

The value of the header to add.

replace bool

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.

RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

headerName string

The name of the header.

headerValue string

The value of the header to add.

replace boolean

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.

headerName str

The name of the header.

headerValue str

The value of the header to add.

replace bool

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.

RegionUrlMapPathMatcherPathRuleUrlRedirect

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

StripQuery bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

HttpsRedirect bool

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

HttpsRedirect bool

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

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

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

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

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

httpsRedirect boolean

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

hostRedirect str

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 bool

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 str

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 str

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 str

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.

RegionUrlMapPathMatcherRouteRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Priority int

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.

HeaderAction RegionUrlMapPathMatcherRouteRuleHeaderActionArgs

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

MatchRules List<RegionUrlMapPathMatcherRouteRuleMatchRuleArgs>

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

RouteAction RegionUrlMapPathMatcherRouteRuleRouteActionArgs

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. Structure is documented below.

Service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

UrlRedirect RegionUrlMapPathMatcherRouteRuleUrlRedirectArgs

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. Structure is documented below.

Priority int

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.

HeaderAction RegionUrlMapPathMatcherRouteRuleHeaderAction

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

MatchRules []RegionUrlMapPathMatcherRouteRuleMatchRule

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

RouteAction RegionUrlMapPathMatcherRouteRuleRouteAction

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. Structure is documented below.

Service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

UrlRedirect RegionUrlMapPathMatcherRouteRuleUrlRedirect

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. Structure is documented below.

priority number

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.

headerAction RegionUrlMapPathMatcherRouteRuleHeaderAction

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

matchRules RegionUrlMapPathMatcherRouteRuleMatchRule[]

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

routeAction RegionUrlMapPathMatcherRouteRuleRouteAction

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. Structure is documented below.

service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

urlRedirect RegionUrlMapPathMatcherRouteRuleUrlRedirect

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. Structure is documented below.

priority float

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.

header_action Dict[RegionUrlMapPathMatcherRouteRuleHeaderAction]

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

matchRules List[RegionUrlMapPathMatcherRouteRuleMatchRule]

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

routeAction Dict[RegionUrlMapPathMatcherRouteRuleRouteAction]

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. Structure is documented below.

service str

A reference to expected RegionBackendService resource the given URL should be mapped to.

urlRedirect Dict[RegionUrlMapPathMatcherRouteRuleUrlRedirect]

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. Structure is documented below.

RegionUrlMapPathMatcherRouteRuleHeaderAction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

RequestHeadersToAdds List<RegionUrlMapPathMatcherRouteRuleHeaderActionRequestHeadersToAddArgs>

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

RequestHeadersToRemoves List<string>

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

ResponseHeadersToAdds List<RegionUrlMapPathMatcherRouteRuleHeaderActionResponseHeadersToAddArgs>

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

ResponseHeadersToRemoves List<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.

RequestHeadersToAdds []RegionUrlMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd

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

RequestHeadersToRemoves []string

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

ResponseHeadersToAdds []RegionUrlMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd

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

ResponseHeadersToRemoves []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.

requestHeadersToAdds RegionUrlMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd[]

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

requestHeadersToRemoves string[]

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

responseHeadersToAdds RegionUrlMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd[]

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

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

requestHeadersToAdds List[RegionUrlMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd]

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

requestHeadersToRemoves List[str]

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

responseHeadersToAdds List[RegionUrlMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd]

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

responseHeadersToRemoves List[str]

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

RegionUrlMapPathMatcherRouteRuleHeaderActionRequestHeadersToAdd

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

headerName string

The name of the header.

headerValue string

The value of the header to add.

replace boolean

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.

headerName str

The name of the header.

headerValue str

The value of the header to add.

replace bool

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.

RegionUrlMapPathMatcherRouteRuleHeaderActionResponseHeadersToAdd

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

headerName string

The name of the header.

headerValue string

The value of the header to add.

replace boolean

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.

headerName str

The name of the header.

headerValue str

The value of the header to add.

replace bool

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.

RegionUrlMapPathMatcherRouteRuleMatchRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

FullPathMatch string

For satifying 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 List<RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatchArgs>

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

IgnoreCase bool

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

MetadataFilters List<RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilterArgs>

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

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

QueryParameterMatches List<RegionUrlMapPathMatcherRouteRuleMatchRuleQueryParameterMatchArgs>

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

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

FullPathMatch string

For satifying 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 []RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatch

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

IgnoreCase bool

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

MetadataFilters []RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilter

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

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

QueryParameterMatches []RegionUrlMapPathMatcherRouteRuleMatchRuleQueryParameterMatch

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

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

fullPathMatch string

For satifying 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 RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatch[]

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

ignoreCase boolean

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

metadataFilters RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilter[]

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

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

queryParameterMatches RegionUrlMapPathMatcherRouteRuleMatchRuleQueryParameterMatch[]

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

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

fullPathMatch str

For satifying 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 List[RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatch]

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

ignoreCase bool

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

metadata_filters List[RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilter]

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

prefixMatch str

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.

queryParameterMatches List[RegionUrlMapPathMatcherRouteRuleMatchRuleQueryParameterMatch]

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

regexMatch str

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.

RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatch

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HeaderName string

The name of the header.

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

InvertMatch bool

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

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 bool

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.

RangeMatch RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatchArgs

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

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

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

HeaderName string

The name of the header.

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

InvertMatch bool

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

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 bool

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.

RangeMatch RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch

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

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

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

headerName string

The name of the header.

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

invertMatch boolean

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

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

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.

rangeMatch RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch

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

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

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

headerName str

The name of the header.

exactMatch str

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.

invertMatch bool

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 str

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 bool

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.

rangeMatch Dict[RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch]

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

regexMatch str

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.

suffixMatch str

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.

RegionUrlMapPathMatcherRouteRuleMatchRuleHeaderMatchRangeMatch

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

RangeEnd int

The end of the range (exclusive).

RangeStart int

The start of the range (inclusive).

RangeEnd int

The end of the range (exclusive).

RangeStart int

The start of the range (inclusive).

rangeEnd number

The end of the range (exclusive).

rangeStart number

The start of the range (inclusive).

rangeEnd float

The end of the range (exclusive).

rangeStart float

The start of the range (inclusive).

RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilter

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

FilterLabels List<RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabelArgs>

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

FilterMatchCriteria string

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.

FilterLabels []RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel

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

FilterMatchCriteria string

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.

filterLabels RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel[]

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

filterMatchCriteria string

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.

filterLabels List[RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel]

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

filterMatchCriteria str

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.

RegionUrlMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabel

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

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.

Value string

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

Name string

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.

Value string

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

name string

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.

value string

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

name str

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.

value str

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

RegionUrlMapPathMatcherRouteRuleMatchRuleQueryParameterMatch

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

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.

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

PresentMatch bool

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

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.

Name string

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.

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

PresentMatch bool

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

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.

name string

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.

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

presentMatch boolean

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

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.

name str

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.

exactMatch str

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.

presentMatch bool

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 str

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.

RegionUrlMapPathMatcherRouteRuleRouteAction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CorsPolicy RegionUrlMapPathMatcherRouteRuleRouteActionCorsPolicyArgs

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

FaultInjectionPolicy RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyArgs

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

RequestMirrorPolicy RegionUrlMapPathMatcherRouteRuleRouteActionRequestMirrorPolicyArgs

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

RetryPolicy RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicyArgs

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

Timeout RegionUrlMapPathMatcherRouteRuleRouteActionTimeoutArgs

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

UrlRewrite RegionUrlMapPathMatcherRouteRuleRouteActionUrlRewriteArgs

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

WeightedBackendServices List<RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceArgs>

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

CorsPolicy RegionUrlMapPathMatcherRouteRuleRouteActionCorsPolicy

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

FaultInjectionPolicy RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy

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

RequestMirrorPolicy RegionUrlMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy

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

RetryPolicy RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicy

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

Timeout RegionUrlMapPathMatcherRouteRuleRouteActionTimeout

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

UrlRewrite RegionUrlMapPathMatcherRouteRuleRouteActionUrlRewrite

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

WeightedBackendServices []RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendService

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

corsPolicy RegionUrlMapPathMatcherRouteRuleRouteActionCorsPolicy

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

faultInjectionPolicy RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy

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

requestMirrorPolicy RegionUrlMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy

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

retryPolicy RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicy

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

timeout RegionUrlMapPathMatcherRouteRuleRouteActionTimeout

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

urlRewrite RegionUrlMapPathMatcherRouteRuleRouteActionUrlRewrite

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

weightedBackendServices RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendService[]

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

corsPolicy Dict[RegionUrlMapPathMatcherRouteRuleRouteActionCorsPolicy]

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

faultInjectionPolicy Dict[RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy]

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

requestMirrorPolicy Dict[RegionUrlMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy]

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

retryPolicy Dict[RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicy]

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

timeout Dict[RegionUrlMapPathMatcherRouteRuleRouteActionTimeout]

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

urlRewrite Dict[RegionUrlMapPathMatcherRouteRuleRouteActionUrlRewrite]

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

weightedBackendServices List[RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendService]

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

RegionUrlMapPathMatcherRouteRuleRouteActionCorsPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AllowCredentials bool

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

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

AllowMethods List<string>

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

AllowOriginRegexes List<string>

Specifies the regualar 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<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 bool

If true, specifies the CORS policy is disabled.

ExposeHeaders List<string>

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

MaxAge int

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

AllowCredentials bool

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 []string

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

AllowMethods []string

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

AllowOriginRegexes []string

Specifies the regualar 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 []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 bool

If true, specifies the CORS policy is disabled.

ExposeHeaders []string

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

MaxAge int

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

allowCredentials boolean

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 string[]

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

allowMethods string[]

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

allowOriginRegexes string[]

Specifies the regualar 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 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

If true, specifies the CORS policy is disabled.

exposeHeaders string[]

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

maxAge number

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

allowCredentials bool

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[str]

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

allowMethods List[str]

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

allowOriginRegexes List[str]

Specifies the regualar 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[str]

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 bool

If true, specifies the CORS policy is disabled.

exposeHeaders List[str]

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

maxAge float

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

RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Abort RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbortArgs

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

Delay RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayArgs

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

Abort RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort

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

Delay RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay

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

abort RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort

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

delay RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay

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

abort Dict[RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort]

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

delay Dict[RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay]

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

RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyAbort

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HttpStatus int

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

Percentage double

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.

HttpStatus int

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

Percentage float64

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.

httpStatus number

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

percentage number

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.

httpStatus float

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

percentage float

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.

RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelay

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

FixedDelay RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelayArgs

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

Percentage double

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.

FixedDelay RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay

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

Percentage float64

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.

fixedDelay RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay

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

percentage number

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.

fixedDelay Dict[RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay]

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

percentage float

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.

RegionUrlMapPathMatcherRouteRuleRouteActionFaultInjectionPolicyDelayFixedDelay

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Seconds string

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

Nanos int

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.

Nanos int

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.

nanos number

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 str

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

nanos float

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.

RegionUrlMapPathMatcherRouteRuleRouteActionRequestMirrorPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

BackendService string

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

BackendService string

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

backendService string

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

backend_service str

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

RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

NumRetries int

Specifies the allowed number retries. This number must be > 0.

PerTryTimeout RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeoutArgs

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

RetryConditions List<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

NumRetries int

Specifies the allowed number retries. This number must be > 0.

PerTryTimeout RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout

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

RetryConditions []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

numRetries number

Specifies the allowed number retries. This number must be > 0.

perTryTimeout RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout

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

retryConditions 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

numRetries float

Specifies the allowed number retries. This number must be > 0.

perTryTimeout Dict[RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout]

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

retryConditions List[str]

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

RegionUrlMapPathMatcherRouteRuleRouteActionRetryPolicyPerTryTimeout

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Seconds string

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

Nanos int

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.

Nanos int

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.

nanos number

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 str

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

nanos float

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.

RegionUrlMapPathMatcherRouteRuleRouteActionTimeout

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Seconds string

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

Nanos int

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.

Nanos int

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.

nanos number

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 str

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

nanos float

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.

RegionUrlMapPathMatcherRouteRuleRouteActionUrlRewrite

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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

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

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

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

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

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

hostRewrite str

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 str

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.

RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendService

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

BackendService string

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

Weight int

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

HeaderAction RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionArgs

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

BackendService string

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

Weight int

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

HeaderAction RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction

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

backendService string

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

weight number

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

headerAction RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction

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

backend_service str

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

weight float

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

header_action Dict[RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction]

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

RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderAction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

RequestHeadersToAdds List<RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs>

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

RequestHeadersToRemoves List<string>

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

ResponseHeadersToAdds List<RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs>

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

ResponseHeadersToRemoves List<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.

RequestHeadersToAdds []RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

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

RequestHeadersToRemoves []string

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

ResponseHeadersToAdds []RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

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

ResponseHeadersToRemoves []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.

requestHeadersToAdds RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd[]

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

requestHeadersToRemoves string[]

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

responseHeadersToAdds RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd[]

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

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

requestHeadersToAdds List[RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd]

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

requestHeadersToRemoves List[str]

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

responseHeadersToAdds List[RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd]

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

responseHeadersToRemoves List[str]

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

RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

headerName string

The name of the header.

headerValue string

The value of the header to add.

replace boolean

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.

headerName str

The name of the header.

headerValue str

The value of the header to add.

replace bool

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.

RegionUrlMapPathMatcherRouteRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

HeaderName string

The name of the header.

HeaderValue string

The value of the header to add.

Replace bool

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.

headerName string

The name of the header.

headerValue string

The value of the header to add.

replace boolean

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.

headerName str

The name of the header.

headerValue str

The value of the header to add.

replace bool

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.

RegionUrlMapPathMatcherRouteRuleUrlRedirect

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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

HttpsRedirect bool

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

HttpsRedirect bool

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

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

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

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

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

httpsRedirect boolean

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

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

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

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

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. This field is required to ensure an empty block is not set. The normal default value is false.

hostRedirect str

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 bool

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 str

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 str

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 str

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 bool

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. This field is required to ensure an empty block is not set. The normal default value is false.

RegionUrlMapTest

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Host string

Host portion of the URL.

Path string

Path portion of the URL.

Service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

Description string

Description of this test case.

Host string

Host portion of the URL.

Path string

Path portion of the URL.

Service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

Description string

Description of this test case.

host string

Host portion of the URL.

path string

Path portion of the URL.

service string

A reference to expected RegionBackendService resource the given URL should be mapped to.

description string

Description of this test case.

host str

Host portion of the URL.

path str

Path portion of the URL.

service str

A reference to expected RegionBackendService resource the given URL should be mapped to.

description str

Description of this test case.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.