gcp.compute.URLMap
Explore with Pulumi AI
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.
To get more information about UrlMap, see:
Example Usage
Url Map Bucket And Service
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HttpHealthCheck;
import com.pulumi.gcp.compute.HttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.compute.BackendBucket;
import com.pulumi.gcp.compute.BackendBucketArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import com.pulumi.gcp.compute.inputs.URLMapTestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HttpHealthCheck("default", HttpHealthCheckArgs.builder()
.requestPath("/")
.checkIntervalSec(1)
.timeoutSec(1)
.build());
var login = new BackendService("login", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(default_.id())
.build());
var staticBucket = new Bucket("staticBucket", BucketArgs.builder()
.location("US")
.build());
var staticBackendBucket = new BackendBucket("staticBackendBucket", BackendBucketArgs.builder()
.bucketName(staticBucket.name())
.enableCdn(true)
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("a description")
.defaultService(staticBackendBucket.id())
.hostRules(
URLMapHostRuleArgs.builder()
.hosts("mysite.com")
.pathMatcher("mysite")
.build(),
URLMapHostRuleArgs.builder()
.hosts("myothersite.com")
.pathMatcher("otherpaths")
.build())
.pathMatchers(
URLMapPathMatcherArgs.builder()
.name("mysite")
.defaultService(staticBackendBucket.id())
.pathRules(
URLMapPathMatcherPathRuleArgs.builder()
.paths("/home")
.service(staticBackendBucket.id())
.build(),
URLMapPathMatcherPathRuleArgs.builder()
.paths("/login")
.service(login.id())
.build(),
URLMapPathMatcherPathRuleArgs.builder()
.paths("/static")
.service(staticBackendBucket.id())
.build())
.build(),
URLMapPathMatcherArgs.builder()
.name("otherpaths")
.defaultService(staticBackendBucket.id())
.build())
.tests(URLMapTestArgs.builder()
.service(staticBackendBucket.id())
.host("example.com")
.path("/home")
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: a description
defaultService: ${staticBackendBucket.id}
hostRules:
- hosts:
- mysite.com
pathMatcher: mysite
- hosts:
- myothersite.com
pathMatcher: otherpaths
pathMatchers:
- name: mysite
defaultService: ${staticBackendBucket.id}
pathRules:
- paths:
- /home
service: ${staticBackendBucket.id}
- paths:
- /login
service: ${login.id}
- paths:
- /static
service: ${staticBackendBucket.id}
- name: otherpaths
defaultService: ${staticBackendBucket.id}
tests:
- service: ${staticBackendBucket.id}
host: example.com
path: /home
login:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${default.id}
default:
type: gcp:compute:HttpHealthCheck
properties:
requestPath: /
checkIntervalSec: 1
timeoutSec: 1
staticBackendBucket:
type: gcp:compute:BackendBucket
properties:
bucketName: ${staticBucket.name}
enableCdn: true
staticBucket:
type: gcp:storage:Bucket
properties:
location: US
Url Map Traffic Director Route
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import com.pulumi.gcp.compute.inputs.URLMapTestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HealthCheck("default", HealthCheckArgs.builder()
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var home = new BackendService("home", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(default_.id())
.loadBalancingScheme("INTERNAL_SELF_MANAGED")
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("a description")
.defaultService(home.id())
.hostRules(URLMapHostRuleArgs.builder()
.hosts("mysite.com")
.pathMatcher("allpaths")
.build())
.pathMatchers(URLMapPathMatcherArgs.builder()
.name("allpaths")
.defaultService(home.id())
.routeRules(URLMapPathMatcherRouteRuleArgs.builder()
.priority(1)
.headerAction(URLMapPathMatcherRouteRuleHeaderActionArgs.builder()
.requestHeadersToRemoves("RemoveMe2")
.requestHeadersToAdds(URLMapPathMatcherRouteRuleHeaderActionRequestHeadersToAddArgs.builder()
.headerName("AddSomethingElse")
.headerValue("MyOtherValue")
.replace(true)
.build())
.responseHeadersToRemoves("RemoveMe3")
.responseHeadersToAdds(URLMapPathMatcherRouteRuleHeaderActionResponseHeadersToAddArgs.builder()
.headerName("AddMe")
.headerValue("MyValue")
.replace(false)
.build())
.build())
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.fullPathMatch("a full path")
.headerMatches(URLMapPathMatcherRouteRuleMatchRuleHeaderMatchArgs.builder()
.headerName("someheader")
.exactMatch("match this exactly")
.invertMatch(true)
.build())
.ignoreCase(true)
.metadataFilters(URLMapPathMatcherRouteRuleMatchRuleMetadataFilterArgs.builder()
.filterMatchCriteria("MATCH_ANY")
.filterLabels(URLMapPathMatcherRouteRuleMatchRuleMetadataFilterFilterLabelArgs.builder()
.name("PLANET")
.value("MARS")
.build())
.build())
.queryParameterMatches(URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatchArgs.builder()
.name("a query parameter")
.presentMatch(true)
.build())
.build())
.urlRedirect(URLMapPathMatcherRouteRuleUrlRedirectArgs.builder()
.hostRedirect("A host")
.httpsRedirect(false)
.pathRedirect("some/path")
.redirectResponseCode("TEMPORARY_REDIRECT")
.stripQuery(true)
.build())
.build())
.build())
.tests(URLMapTestArgs.builder()
.service(home.id())
.host("hi.com")
.path("/home")
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: a description
defaultService: ${home.id}
hostRules:
- hosts:
- mysite.com
pathMatcher: allpaths
pathMatchers:
- name: allpaths
defaultService: ${home.id}
routeRules:
- priority: 1
headerAction:
requestHeadersToRemoves:
- RemoveMe2
requestHeadersToAdds:
- headerName: AddSomethingElse
headerValue: MyOtherValue
replace: true
responseHeadersToRemoves:
- RemoveMe3
responseHeadersToAdds:
- headerName: AddMe
headerValue: MyValue
replace: false
matchRules:
- fullPathMatch: a full path
headerMatches:
- headerName: someheader
exactMatch: match this exactly
invertMatch: true
ignoreCase: true
metadataFilters:
- filterMatchCriteria: MATCH_ANY
filterLabels:
- name: PLANET
value: MARS
queryParameterMatches:
- name: a query parameter
presentMatch: true
urlRedirect:
hostRedirect: A host
httpsRedirect: false
pathRedirect: some/path
redirectResponseCode: TEMPORARY_REDIRECT
stripQuery: true
tests:
- service: ${home.id}
host: hi.com
path: /home
home:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${default.id}
loadBalancingScheme: INTERNAL_SELF_MANAGED
default:
type: gcp:compute:HealthCheck
properties:
httpHealthCheck:
port: 80
Url Map Traffic Director Route Partial
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import com.pulumi.gcp.compute.inputs.URLMapTestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HealthCheck("default", HealthCheckArgs.builder()
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var home = new BackendService("home", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(default_.id())
.loadBalancingScheme("INTERNAL_SELF_MANAGED")
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("a description")
.defaultService(home.id())
.hostRules(URLMapHostRuleArgs.builder()
.hosts("mysite.com")
.pathMatcher("allpaths")
.build())
.pathMatchers(URLMapPathMatcherArgs.builder()
.name("allpaths")
.defaultService(home.id())
.routeRules(URLMapPathMatcherRouteRuleArgs.builder()
.priority(1)
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.prefixMatch("/someprefix")
.headerMatches(URLMapPathMatcherRouteRuleMatchRuleHeaderMatchArgs.builder()
.headerName("someheader")
.exactMatch("match this exactly")
.invertMatch(true)
.build())
.build())
.urlRedirect(URLMapPathMatcherRouteRuleUrlRedirectArgs.builder()
.pathRedirect("some/path")
.redirectResponseCode("TEMPORARY_REDIRECT")
.build())
.build())
.build())
.tests(URLMapTestArgs.builder()
.service(home.id())
.host("hi.com")
.path("/home")
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: a description
defaultService: ${home.id}
hostRules:
- hosts:
- mysite.com
pathMatcher: allpaths
pathMatchers:
- name: allpaths
defaultService: ${home.id}
routeRules:
- priority: 1
matchRules:
- prefixMatch: /someprefix
headerMatches:
- headerName: someheader
exactMatch: match this exactly
invertMatch: true
urlRedirect:
pathRedirect: some/path
redirectResponseCode: TEMPORARY_REDIRECT
tests:
- service: ${home.id}
host: hi.com
path: /home
home:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${default.id}
loadBalancingScheme: INTERNAL_SELF_MANAGED
default:
type: gcp:compute:HealthCheck
properties:
httpHealthCheck:
port: 80
Url Map Traffic Director Path
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import com.pulumi.gcp.compute.inputs.URLMapTestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HealthCheck("default", HealthCheckArgs.builder()
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var home = new BackendService("home", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(default_.id())
.loadBalancingScheme("INTERNAL_SELF_MANAGED")
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("a description")
.defaultService(home.id())
.hostRules(URLMapHostRuleArgs.builder()
.hosts("mysite.com")
.pathMatcher("allpaths")
.build())
.pathMatchers(URLMapPathMatcherArgs.builder()
.name("allpaths")
.defaultService(home.id())
.pathRules(URLMapPathMatcherPathRuleArgs.builder()
.paths("/home")
.routeAction(URLMapPathMatcherPathRuleRouteActionArgs.builder()
.corsPolicy(URLMapPathMatcherPathRuleRouteActionCorsPolicyArgs.builder()
.allowCredentials(true)
.allowHeaders("Allowed content")
.allowMethods("GET")
.allowOriginRegexes("abc.*")
.allowOrigins("Allowed origin")
.exposeHeaders("Exposed header")
.maxAge(30)
.disabled(false)
.build())
.faultInjectionPolicy(URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyArgs.builder()
.abort(URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbortArgs.builder()
.httpStatus(234)
.percentage(5.6)
.build())
.delay(URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayArgs.builder()
.fixedDelay(URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelayArgs.builder()
.seconds(0)
.nanos(50000)
.build())
.percentage(7.8)
.build())
.build())
.requestMirrorPolicy(URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicyArgs.builder()
.backendService(home.id())
.build())
.retryPolicy(URLMapPathMatcherPathRuleRouteActionRetryPolicyArgs.builder()
.numRetries(4)
.perTryTimeout(URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeoutArgs.builder()
.seconds(30)
.build())
.retryConditions(
"5xx",
"deadline-exceeded")
.build())
.timeout(URLMapPathMatcherPathRuleRouteActionTimeoutArgs.builder()
.seconds(20)
.nanos(750000000)
.build())
.urlRewrite(URLMapPathMatcherPathRuleRouteActionUrlRewriteArgs.builder()
.hostRewrite("dev.example.com")
.pathPrefixRewrite("/v1/api/")
.build())
.weightedBackendServices(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceArgs.builder()
.backendService(home.id())
.weight(400)
.headerAction(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionArgs.builder()
.requestHeadersToRemoves("RemoveMe")
.requestHeadersToAdds(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs.builder()
.headerName("AddMe")
.headerValue("MyValue")
.replace(true)
.build())
.responseHeadersToRemoves("RemoveMe")
.responseHeadersToAdds(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs.builder()
.headerName("AddMe")
.headerValue("MyValue")
.replace(false)
.build())
.build())
.build())
.build())
.build())
.build())
.tests(URLMapTestArgs.builder()
.service(home.id())
.host("hi.com")
.path("/home")
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: a description
defaultService: ${home.id}
hostRules:
- hosts:
- mysite.com
pathMatcher: allpaths
pathMatchers:
- name: allpaths
defaultService: ${home.id}
pathRules:
- paths:
- /home
routeAction:
corsPolicy:
allowCredentials: true
allowHeaders:
- Allowed content
allowMethods:
- GET
allowOriginRegexes:
- abc.*
allowOrigins:
- Allowed origin
exposeHeaders:
- Exposed header
maxAge: 30
disabled: false
faultInjectionPolicy:
abort:
httpStatus: 234
percentage: 5.6
delay:
fixedDelay:
seconds: 0
nanos: 50000
percentage: 7.8
requestMirrorPolicy:
backendService: ${home.id}
retryPolicy:
numRetries: 4
perTryTimeout:
seconds: 30
retryConditions:
- 5xx
- deadline-exceeded
timeout:
seconds: 20
nanos: 7.5e+08
urlRewrite:
hostRewrite: dev.example.com
pathPrefixRewrite: /v1/api/
weightedBackendServices:
- backendService: ${home.id}
weight: 400
headerAction:
requestHeadersToRemoves:
- RemoveMe
requestHeadersToAdds:
- headerName: AddMe
headerValue: MyValue
replace: true
responseHeadersToRemoves:
- RemoveMe
responseHeadersToAdds:
- headerName: AddMe
headerValue: MyValue
replace: false
tests:
- service: ${home.id}
host: hi.com
path: /home
home:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${default.id}
loadBalancingScheme: INTERNAL_SELF_MANAGED
default:
type: gcp:compute:HealthCheck
properties:
httpHealthCheck:
port: 80
Url Map Traffic Director Path Partial
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import com.pulumi.gcp.compute.inputs.URLMapTestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HealthCheck("default", HealthCheckArgs.builder()
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.port(80)
.build())
.build());
var home = new BackendService("home", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(default_.id())
.loadBalancingScheme("INTERNAL_SELF_MANAGED")
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("a description")
.defaultService(home.id())
.hostRules(URLMapHostRuleArgs.builder()
.hosts("mysite.com")
.pathMatcher("allpaths")
.build())
.pathMatchers(URLMapPathMatcherArgs.builder()
.name("allpaths")
.defaultService(home.id())
.pathRules(URLMapPathMatcherPathRuleArgs.builder()
.paths("/home")
.routeAction(URLMapPathMatcherPathRuleRouteActionArgs.builder()
.corsPolicy(URLMapPathMatcherPathRuleRouteActionCorsPolicyArgs.builder()
.allowCredentials(true)
.allowHeaders("Allowed content")
.allowMethods("GET")
.allowOriginRegexes("abc.*")
.allowOrigins("Allowed origin")
.exposeHeaders("Exposed header")
.maxAge(30)
.disabled(false)
.build())
.weightedBackendServices(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceArgs.builder()
.backendService(home.id())
.weight(400)
.headerAction(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionArgs.builder()
.requestHeadersToRemoves("RemoveMe")
.requestHeadersToAdds(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs.builder()
.headerName("AddMe")
.headerValue("MyValue")
.replace(true)
.build())
.responseHeadersToRemoves("RemoveMe")
.responseHeadersToAdds(URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs.builder()
.headerName("AddMe")
.headerValue("MyValue")
.replace(false)
.build())
.build())
.build())
.build())
.build())
.build())
.tests(URLMapTestArgs.builder()
.service(home.id())
.host("hi.com")
.path("/home")
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: a description
defaultService: ${home.id}
hostRules:
- hosts:
- mysite.com
pathMatcher: allpaths
pathMatchers:
- name: allpaths
defaultService: ${home.id}
pathRules:
- paths:
- /home
routeAction:
corsPolicy:
allowCredentials: true
allowHeaders:
- Allowed content
allowMethods:
- GET
allowOriginRegexes:
- abc.*
allowOrigins:
- Allowed origin
exposeHeaders:
- Exposed header
maxAge: 30
disabled: false
weightedBackendServices:
- backendService: ${home.id}
weight: 400
headerAction:
requestHeadersToRemoves:
- RemoveMe
requestHeadersToAdds:
- headerName: AddMe
headerValue: MyValue
replace: true
responseHeadersToRemoves:
- RemoveMe
responseHeadersToAdds:
- headerName: AddMe
headerValue: MyValue
replace: false
tests:
- service: ${home.id}
host: hi.com
path: /home
home:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${default.id}
loadBalancingScheme: INTERNAL_SELF_MANAGED
default:
type: gcp:compute:HealthCheck
properties:
httpHealthCheck:
port: 80
Url Map Header Based Routing
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HttpHealthCheck;
import com.pulumi.gcp.compute.HttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder()
.requestPath("/")
.checkIntervalSec(1)
.timeoutSec(1)
.build());
var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(defaultHttpHealthCheck.id())
.build());
var service_a = new BackendService("service-a", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(defaultHttpHealthCheck.id())
.build());
var service_b = new BackendService("service-b", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(defaultHttpHealthCheck.id())
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("header-based routing example")
.defaultService(defaultBackendService.id())
.hostRules(URLMapHostRuleArgs.builder()
.hosts("*")
.pathMatcher("allpaths")
.build())
.pathMatchers(URLMapPathMatcherArgs.builder()
.name("allpaths")
.defaultService(defaultBackendService.id())
.routeRules(
URLMapPathMatcherRouteRuleArgs.builder()
.priority(1)
.service(service_a.id())
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.prefixMatch("/")
.ignoreCase(true)
.headerMatches(URLMapPathMatcherRouteRuleMatchRuleHeaderMatchArgs.builder()
.headerName("abtest")
.exactMatch("a")
.build())
.build())
.build(),
URLMapPathMatcherRouteRuleArgs.builder()
.priority(2)
.service(service_b.id())
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.ignoreCase(true)
.prefixMatch("/")
.headerMatches(URLMapPathMatcherRouteRuleMatchRuleHeaderMatchArgs.builder()
.headerName("abtest")
.exactMatch("b")
.build())
.build())
.build())
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: header-based routing example
defaultService: ${defaultBackendService.id}
hostRules:
- hosts:
- '*'
pathMatcher: allpaths
pathMatchers:
- name: allpaths
defaultService: ${defaultBackendService.id}
routeRules:
- priority: 1
service: ${["service-a"].id}
matchRules:
- prefixMatch: /
ignoreCase: true
headerMatches:
- headerName: abtest
exactMatch: a
- priority: 2
service: ${["service-b"].id}
matchRules:
- ignoreCase: true
prefixMatch: /
headerMatches:
- headerName: abtest
exactMatch: b
defaultBackendService:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${defaultHttpHealthCheck.id}
service-a:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${defaultHttpHealthCheck.id}
service-b:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${defaultHttpHealthCheck.id}
defaultHttpHealthCheck:
type: gcp:compute:HttpHealthCheck
properties:
requestPath: /
checkIntervalSec: 1
timeoutSec: 1
Url Map Parameter Based Routing
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HttpHealthCheck;
import com.pulumi.gcp.compute.HttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var defaultHttpHealthCheck = new HttpHealthCheck("defaultHttpHealthCheck", HttpHealthCheckArgs.builder()
.requestPath("/")
.checkIntervalSec(1)
.timeoutSec(1)
.build());
var defaultBackendService = new BackendService("defaultBackendService", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(defaultHttpHealthCheck.id())
.build());
var service_a = new BackendService("service-a", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(defaultHttpHealthCheck.id())
.build());
var service_b = new BackendService("service-b", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.healthChecks(defaultHttpHealthCheck.id())
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("parameter-based routing example")
.defaultService(defaultBackendService.id())
.hostRules(URLMapHostRuleArgs.builder()
.hosts("*")
.pathMatcher("allpaths")
.build())
.pathMatchers(URLMapPathMatcherArgs.builder()
.name("allpaths")
.defaultService(defaultBackendService.id())
.routeRules(
URLMapPathMatcherRouteRuleArgs.builder()
.priority(1)
.service(service_a.id())
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.prefixMatch("/")
.ignoreCase(true)
.queryParameterMatches(URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatchArgs.builder()
.name("abtest")
.exactMatch("a")
.build())
.build())
.build(),
URLMapPathMatcherRouteRuleArgs.builder()
.priority(2)
.service(service_b.id())
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.ignoreCase(true)
.prefixMatch("/")
.queryParameterMatches(URLMapPathMatcherRouteRuleMatchRuleQueryParameterMatchArgs.builder()
.name("abtest")
.exactMatch("b")
.build())
.build())
.build())
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: parameter-based routing example
defaultService: ${defaultBackendService.id}
hostRules:
- hosts:
- '*'
pathMatcher: allpaths
pathMatchers:
- name: allpaths
defaultService: ${defaultBackendService.id}
routeRules:
- priority: 1
service: ${["service-a"].id}
matchRules:
- prefixMatch: /
ignoreCase: true
queryParameterMatches:
- name: abtest
exactMatch: a
- priority: 2
service: ${["service-b"].id}
matchRules:
- ignoreCase: true
prefixMatch: /
queryParameterMatches:
- name: abtest
exactMatch: b
defaultBackendService:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${defaultHttpHealthCheck.id}
service-a:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${defaultHttpHealthCheck.id}
service-b:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
healthChecks:
- ${defaultHttpHealthCheck.id}
defaultHttpHealthCheck:
type: gcp:compute:HttpHealthCheck
properties:
requestPath: /
checkIntervalSec: 1
timeoutSec: 1
Url Map Path Template Match
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HttpHealthCheck;
import com.pulumi.gcp.compute.HttpHealthCheckArgs;
import com.pulumi.gcp.compute.BackendService;
import com.pulumi.gcp.compute.BackendServiceArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.compute.BackendBucket;
import com.pulumi.gcp.compute.BackendBucketArgs;
import com.pulumi.gcp.compute.URLMap;
import com.pulumi.gcp.compute.URLMapArgs;
import com.pulumi.gcp.compute.inputs.URLMapHostRuleArgs;
import com.pulumi.gcp.compute.inputs.URLMapPathMatcherArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HttpHealthCheck("default", HttpHealthCheckArgs.builder()
.requestPath("/")
.checkIntervalSec(1)
.timeoutSec(1)
.build());
var cart_backend = new BackendService("cart-backend", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.loadBalancingScheme("EXTERNAL_MANAGED")
.healthChecks(default_.id())
.build());
var user_backend = new BackendService("user-backend", BackendServiceArgs.builder()
.portName("http")
.protocol("HTTP")
.timeoutSec(10)
.loadBalancingScheme("EXTERNAL_MANAGED")
.healthChecks(default_.id())
.build());
var staticBucket = new Bucket("staticBucket", BucketArgs.builder()
.location("US")
.build());
var staticBackendBucket = new BackendBucket("staticBackendBucket", BackendBucketArgs.builder()
.bucketName(staticBucket.name())
.enableCdn(true)
.build());
var urlmap = new URLMap("urlmap", URLMapArgs.builder()
.description("a description")
.defaultService(staticBackendBucket.id())
.hostRules(URLMapHostRuleArgs.builder()
.hosts("mysite.com")
.pathMatcher("mysite")
.build())
.pathMatchers(URLMapPathMatcherArgs.builder()
.name("mysite")
.defaultService(staticBackendBucket.id())
.routeRules(
URLMapPathMatcherRouteRuleArgs.builder()
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.pathTemplateMatch("/xyzwebservices/v2/xyz/users/{username=*}/carts/{cartid=**}")
.build())
.service(cart_backend.id())
.priority(1)
.routeAction(URLMapPathMatcherRouteRuleRouteActionArgs.builder()
.urlRewrite(URLMapPathMatcherRouteRuleRouteActionUrlRewriteArgs.builder()
.pathTemplateRewrite("/{username}-{cartid}/")
.build())
.build())
.build(),
URLMapPathMatcherRouteRuleArgs.builder()
.matchRules(URLMapPathMatcherRouteRuleMatchRuleArgs.builder()
.pathTemplateMatch("/xyzwebservices/v2/xyz/users/*/accountinfo/*")
.build())
.service(user_backend.id())
.priority(2)
.build())
.build())
.build());
}
}
Coming soon!
Coming soon!
resources:
urlmap:
type: gcp:compute:URLMap
properties:
description: a description
defaultService: ${staticBackendBucket.id}
hostRules:
- hosts:
- mysite.com
pathMatcher: mysite
pathMatchers:
- name: mysite
defaultService: ${staticBackendBucket.id}
routeRules:
- matchRules:
- pathTemplateMatch: /xyzwebservices/v2/xyz/users/{username=*}/carts/{cartid=**}
service: ${["cart-backend"].id}
priority: 1
routeAction:
urlRewrite:
pathTemplateRewrite: /{username}-{cartid}/
- matchRules:
- pathTemplateMatch: /xyzwebservices/v2/xyz/users/*/accountinfo/*
service: ${["user-backend"].id}
priority: 2
cart-backend:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
loadBalancingScheme: EXTERNAL_MANAGED
healthChecks:
- ${default.id}
user-backend:
type: gcp:compute:BackendService
properties:
portName: http
protocol: HTTP
timeoutSec: 10
loadBalancingScheme: EXTERNAL_MANAGED
healthChecks:
- ${default.id}
default:
type: gcp:compute:HttpHealthCheck
properties:
requestPath: /
checkIntervalSec: 1
timeoutSec: 1
staticBackendBucket:
type: gcp:compute:BackendBucket
properties:
bucketName: ${staticBucket.name}
enableCdn: true
staticBucket:
type: gcp:storage:Bucket
properties:
location: US
Create URLMap Resource
new URLMap(name: string, args?: URLMapArgs, opts?: CustomResourceOptions);
@overload
def URLMap(resource_name: str,
opts: Optional[ResourceOptions] = None,
default_route_action: Optional[URLMapDefaultRouteActionArgs] = None,
default_service: Optional[str] = None,
default_url_redirect: Optional[URLMapDefaultUrlRedirectArgs] = None,
description: Optional[str] = None,
header_action: Optional[URLMapHeaderActionArgs] = None,
host_rules: Optional[Sequence[URLMapHostRuleArgs]] = None,
name: Optional[str] = None,
path_matchers: Optional[Sequence[URLMapPathMatcherArgs]] = None,
project: Optional[str] = None,
tests: Optional[Sequence[URLMapTestArgs]] = None)
@overload
def URLMap(resource_name: str,
args: Optional[URLMapArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewURLMap(ctx *Context, name string, args *URLMapArgs, opts ...ResourceOption) (*URLMap, error)
public URLMap(string name, URLMapArgs? args = null, CustomResourceOptions? opts = null)
public URLMap(String name, URLMapArgs args)
public URLMap(String name, URLMapArgs args, CustomResourceOptions options)
type: gcp:compute:URLMap
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args URLMapArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args URLMapArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args URLMapArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args URLMapArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args URLMapArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
URLMap Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The URLMap resource accepts the following input properties:
- Default
Route URLMapAction Default Route Action defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- Default
Service string The backend service or backend bucket to use when none of the given rules match.
- Default
Url URLMapRedirect Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- Header
Action URLMapHeader Action Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- Host
Rules List<URLMapHost Rule> The list of HostRules to use against the URL. Structure is documented below.
- Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Path
Matchers List<URLMapPath Matcher> The list of named PathMatchers to use against the URL. Structure is documented below.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Tests
List<URLMap
Test> The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- Default
Route URLMapAction Default Route Action Args defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- Default
Service string The backend service or backend bucket to use when none of the given rules match.
- Default
Url URLMapRedirect Default Url Redirect Args 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
An optional description of this resource. Provide this property when you create the resource.
- Header
Action URLMapHeader Action Args Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- Host
Rules []URLMapHost Rule Args The list of HostRules to use against the URL. Structure is documented below.
- Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Path
Matchers []URLMapPath Matcher Args The list of named PathMatchers to use against the URL. Structure is documented below.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Tests
[]URLMap
Test Args The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- default
Route URLMapAction Default Route Action defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service String The backend service or backend bucket to use when none of the given rules match.
- default
Url URLMapRedirect Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- header
Action URLMapHeader Action Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host
Rules List<URLMapHost Rule> The list of HostRules to use against the URL. Structure is documented below.
- name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path
Matchers List<URLMapPath Matcher> The list of named PathMatchers to use against the URL. Structure is documented below.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- tests
List<URLMap
Test> The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- default
Route URLMapAction Default Route Action defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service string The backend service or backend bucket to use when none of the given rules match.
- default
Url URLMapRedirect Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- header
Action URLMapHeader Action Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host
Rules URLMapHost Rule[] The list of HostRules to use against the URL. Structure is documented below.
- name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path
Matchers URLMapPath Matcher[] The list of named PathMatchers to use against the URL. Structure is documented below.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- tests
URLMap
Test[] The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- default_
route_ URLMapaction Default Route Action Args defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default_
service str The backend service or backend bucket to use when none of the given rules match.
- default_
url_ URLMapredirect Default Url Redirect Args 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
An optional description of this resource. Provide this property when you create the resource.
- header_
action URLMapHeader Action Args Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host_
rules Sequence[URLMapHost Rule Args] The list of HostRules to use against the URL. Structure is documented below.
- name str
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path_
matchers Sequence[URLMapPath Matcher Args] The list of named PathMatchers to use against the URL. Structure is documented below.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- tests
Sequence[URLMap
Test Args] The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- default
Route Property MapAction defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service String The backend service or backend bucket to use when none of the given rules match.
- default
Url Property MapRedirect 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
An optional description of this resource. Provide this property when you create the resource.
- header
Action Property Map Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host
Rules List<Property Map> The list of HostRules to use against the URL. Structure is documented below.
- name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path
Matchers List<Property Map> The list of named PathMatchers to use against the URL. Structure is documented below.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- tests List<Property Map>
The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the URLMap resource produces the following output properties:
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Fingerprint string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Id string
The provider-assigned unique ID for this managed resource.
- Map
Id int The unique identifier for the resource.
- Self
Link string The URI of the created resource.
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Fingerprint string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Id string
The provider-assigned unique ID for this managed resource.
- Map
Id int The unique identifier for the resource.
- Self
Link string The URI of the created resource.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- fingerprint String
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- id String
The provider-assigned unique ID for this managed resource.
- map
Id Integer The unique identifier for the resource.
- self
Link String The URI of the created resource.
- creation
Timestamp string Creation timestamp in RFC3339 text format.
- fingerprint string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- id string
The provider-assigned unique ID for this managed resource.
- map
Id number The unique identifier for the resource.
- self
Link string The URI of the created resource.
- creation_
timestamp str Creation timestamp in RFC3339 text format.
- fingerprint str
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- id str
The provider-assigned unique ID for this managed resource.
- map_
id int The unique identifier for the resource.
- self_
link str The URI of the created resource.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- fingerprint String
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- id String
The provider-assigned unique ID for this managed resource.
- map
Id Number The unique identifier for the resource.
- self
Link String The URI of the created resource.
Look up Existing URLMap Resource
Get an existing URLMap 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?: URLMapState, opts?: CustomResourceOptions): URLMap
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
creation_timestamp: Optional[str] = None,
default_route_action: Optional[URLMapDefaultRouteActionArgs] = None,
default_service: Optional[str] = None,
default_url_redirect: Optional[URLMapDefaultUrlRedirectArgs] = None,
description: Optional[str] = None,
fingerprint: Optional[str] = None,
header_action: Optional[URLMapHeaderActionArgs] = None,
host_rules: Optional[Sequence[URLMapHostRuleArgs]] = None,
map_id: Optional[int] = None,
name: Optional[str] = None,
path_matchers: Optional[Sequence[URLMapPathMatcherArgs]] = None,
project: Optional[str] = None,
self_link: Optional[str] = None,
tests: Optional[Sequence[URLMapTestArgs]] = None) -> URLMap
func GetURLMap(ctx *Context, name string, id IDInput, state *URLMapState, opts ...ResourceOption) (*URLMap, error)
public static URLMap Get(string name, Input<string> id, URLMapState? state, CustomResourceOptions? opts = null)
public static URLMap get(String name, Output<String> id, URLMapState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Default
Route URLMapAction Default Route Action defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- Default
Service string The backend service or backend bucket to use when none of the given rules match.
- Default
Url URLMapRedirect Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- Fingerprint string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Header
Action URLMapHeader Action Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- Host
Rules List<URLMapHost Rule> The list of HostRules to use against the URL. Structure is documented below.
- Map
Id int The unique identifier for the resource.
- Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Path
Matchers List<URLMapPath Matcher> The list of named PathMatchers to use against the URL. Structure is documented below.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Self
Link string The URI of the created resource.
- Tests
List<URLMap
Test> The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Default
Route URLMapAction Default Route Action Args defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- Default
Service string The backend service or backend bucket to use when none of the given rules match.
- Default
Url URLMapRedirect Default Url Redirect Args 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
An optional description of this resource. Provide this property when you create the resource.
- Fingerprint string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- Header
Action URLMapHeader Action Args Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- Host
Rules []URLMapHost Rule Args The list of HostRules to use against the URL. Structure is documented below.
- Map
Id int The unique identifier for the resource.
- Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Path
Matchers []URLMapPath Matcher Args The list of named PathMatchers to use against the URL. Structure is documented below.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Self
Link string The URI of the created resource.
- Tests
[]URLMap
Test Args The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- default
Route URLMapAction Default Route Action defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service String The backend service or backend bucket to use when none of the given rules match.
- default
Url URLMapRedirect Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- fingerprint String
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- header
Action URLMapHeader Action Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host
Rules List<URLMapHost Rule> The list of HostRules to use against the URL. Structure is documented below.
- map
Id Integer The unique identifier for the resource.
- name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path
Matchers List<URLMapPath Matcher> The list of named PathMatchers to use against the URL. Structure is documented below.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self
Link String The URI of the created resource.
- tests
List<URLMap
Test> The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- creation
Timestamp string Creation timestamp in RFC3339 text format.
- default
Route URLMapAction Default Route Action defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service string The backend service or backend bucket to use when none of the given rules match.
- default
Url URLMapRedirect Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- fingerprint string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- header
Action URLMapHeader Action Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host
Rules URLMapHost Rule[] The list of HostRules to use against the URL. Structure is documented below.
- map
Id number The unique identifier for the resource.
- name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path
Matchers URLMapPath Matcher[] The list of named PathMatchers to use against the URL. Structure is documented below.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self
Link string The URI of the created resource.
- tests
URLMap
Test[] The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- creation_
timestamp str Creation timestamp in RFC3339 text format.
- default_
route_ URLMapaction Default Route Action Args defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default_
service str The backend service or backend bucket to use when none of the given rules match.
- default_
url_ URLMapredirect Default Url Redirect Args 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
An optional description of this resource. Provide this property when you create the resource.
- fingerprint str
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- header_
action URLMapHeader Action Args Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host_
rules Sequence[URLMapHost Rule Args] The list of HostRules to use against the URL. Structure is documented below.
- map_
id int The unique identifier for the resource.
- name str
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path_
matchers Sequence[URLMapPath Matcher Args] The list of named PathMatchers to use against the URL. Structure is documented below.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self_
link str The URI of the created resource.
- tests
Sequence[URLMap
Test Args] The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- default
Route Property MapAction defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service String The backend service or backend bucket to use when none of the given rules match.
- default
Url Property MapRedirect 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
An optional description of this resource. Provide this property when you create the resource.
- fingerprint String
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
- header
Action Property Map Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
- host
Rules List<Property Map> The list of HostRules to use against the URL. Structure is documented below.
- map
Id Number The unique identifier for the resource.
- name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- path
Matchers List<Property Map> The list of named PathMatchers to use against the URL. Structure is documented below.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- self
Link String The URI of the created resource.
- tests List<Property Map>
The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.
Supporting Types
URLMapDefaultRouteAction, URLMapDefaultRouteActionArgs
- Cors
Policy URLMapDefault Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- Fault
Injection URLMapPolicy Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- Request
Mirror URLMapPolicy Default Route Action Request Mirror Policy 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.
- Retry
Policy URLMapDefault Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- Timeout
URLMap
Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Url
Rewrite URLMapDefault Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- Weighted
Backend List<URLMapServices Default Route Action Weighted Backend Service> 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.
- Cors
Policy URLMapDefault Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- Fault
Injection URLMapPolicy Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- Request
Mirror URLMapPolicy Default Route Action Request Mirror Policy 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.
- Retry
Policy URLMapDefault Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- Timeout
URLMap
Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Url
Rewrite URLMapDefault Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- Weighted
Backend []URLMapServices Default Route Action Weighted Backend Service 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.
- cors
Policy URLMapDefault Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection URLMapPolicy Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request
Mirror URLMapPolicy Default Route Action Request Mirror Policy 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.
- retry
Policy URLMapDefault Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url
Rewrite URLMapDefault Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted
Backend List<URLMapServices Default Route Action Weighted Backend Service> 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.
- cors
Policy URLMapDefault Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection URLMapPolicy Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request
Mirror URLMapPolicy Default Route Action Request Mirror Policy 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.
- retry
Policy URLMapDefault Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url
Rewrite URLMapDefault Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted
Backend URLMapServices Default Route Action Weighted Backend Service[] 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.
- cors_
policy URLMapDefault Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault_
injection_ URLMappolicy Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request_
mirror_ URLMappolicy Default Route Action Request Mirror Policy 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.
- retry_
policy URLMapDefault Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url_
rewrite URLMapDefault Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted_
backend_ Sequence[URLMapservices Default Route Action Weighted Backend Service] 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.
- cors
Policy Property Map The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection Property MapPolicy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request
Mirror Property MapPolicy 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.
- retry
Policy Property Map Specifies the retry policy associated with this route. Structure is documented below.
- timeout Property Map
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url
Rewrite Property Map The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted
Backend List<Property Map>Services 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.
URLMapDefaultRouteActionCorsPolicy, URLMapDefaultRouteActionCorsPolicyArgs
- Allow
Credentials 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.
- Allow
Headers List<string> Specifies the content for the Access-Control-Allow-Headers header.
- Allow
Methods List<string> Specifies the content for the Access-Control-Allow-Methods header.
- Allow
Origin List<string>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Allow
Origins List<string> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- Expose
Headers List<string> Specifies the content for the Access-Control-Expose-Headers header.
- Max
Age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- Allow
Credentials 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.
- Allow
Headers []string Specifies the content for the Access-Control-Allow-Headers header.
- Allow
Methods []string Specifies the content for the Access-Control-Allow-Methods header.
- Allow
Origin []stringRegexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Allow
Origins []string Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- Expose
Headers []string Specifies the content for the Access-Control-Expose-Headers header.
- Max
Age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow
Credentials 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.
- allow
Headers List<String> Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods List<String> Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin List<String>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins List<String> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled Boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose
Headers List<String> Specifies the content for the Access-Control-Expose-Headers header.
- max
Age Integer Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow
Credentials 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.
- allow
Headers string[] Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods string[] Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin string[]Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins string[] Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose
Headers string[] Specifies the content for the Access-Control-Expose-Headers header.
- max
Age number Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow_
credentials 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.
- allow_
headers Sequence[str] Specifies the content for the Access-Control-Allow-Headers header.
- allow_
methods Sequence[str] Specifies the content for the Access-Control-Allow-Methods header.
- allow_
origin_ Sequence[str]regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow_
origins Sequence[str] Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose_
headers Sequence[str] Specifies the content for the Access-Control-Expose-Headers header.
- max_
age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow
Credentials 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.
- allow
Headers List<String> Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods List<String> Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin List<String>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins List<String> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled Boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose
Headers List<String> Specifies the content for the Access-Control-Expose-Headers header.
- max
Age Number Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
URLMapDefaultRouteActionFaultInjectionPolicy, URLMapDefaultRouteActionFaultInjectionPolicyArgs
- Abort
URLMap
Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- Delay
URLMap
Default Route Action Fault Injection Policy Delay 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
URLMap
Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- Delay
URLMap
Default Route Action Fault Injection Policy Delay 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
URLMap
Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Default Route Action Fault Injection Policy Delay 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
URLMap
Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Default Route Action Fault Injection Policy Delay 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
URLMap
Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Default Route Action Fault Injection Policy Delay 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 Property Map
The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay Property Map
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.
URLMapDefaultRouteActionFaultInjectionPolicyAbort, URLMapDefaultRouteActionFaultInjectionPolicyAbortArgs
- Http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- Http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status Integer 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http_
status int 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
URLMapDefaultRouteActionFaultInjectionPolicyDelay, URLMapDefaultRouteActionFaultInjectionPolicyDelayArgs
- Fixed
Delay URLMapDefault Route Action Fault Injection Policy Delay Fixed Delay 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.
- Fixed
Delay URLMapDefault Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay URLMapDefault Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay URLMapDefault Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed_
delay URLMapDefault Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay Property Map 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.
URLMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelay, URLMapDefaultRouteActionFaultInjectionPolicyDelayFixedDelayArgs
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 str
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
URLMapDefaultRouteActionRequestMirrorPolicy, URLMapDefaultRouteActionRequestMirrorPolicyArgs
- Backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- Backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- backend
Service String The full or partial URL to the BackendService resource being mirrored to.
- backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- backend_
service str The full or partial URL to the BackendService resource being mirrored to.
- backend
Service String The full or partial URL to the BackendService resource being mirrored to.
URLMapDefaultRouteActionRetryPolicy, URLMapDefaultRouteActionRetryPolicyArgs
- Num
Retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Per
Try URLMapTimeout Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Retry
Conditions List<string> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- Num
Retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Per
Try URLMapTimeout Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Retry
Conditions []string Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries Integer Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try URLMapTimeout Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions List<String> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries number Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try URLMapTimeout Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions string[] Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num_
retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per_
try_ URLMaptimeout Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry_
conditions Sequence[str] Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries Number Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try Property MapTimeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions List<String> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
URLMapDefaultRouteActionRetryPolicyPerTryTimeout, URLMapDefaultRouteActionRetryPolicyPerTryTimeoutArgs
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 str
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
URLMapDefaultRouteActionTimeout, URLMapDefaultRouteActionTimeoutArgs
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 str
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
URLMapDefaultRouteActionUrlRewrite, URLMapDefaultRouteActionUrlRewriteArgs
- Host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- Path
Prefix stringRewrite 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.
- Host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- Path
Prefix stringRewrite 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.
- host
Rewrite String Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix StringRewrite 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.
- host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix stringRewrite 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.
- host_
rewrite 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.
- path_
prefix_ strrewrite 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.
- host
Rewrite String Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix StringRewrite 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.
URLMapDefaultRouteActionWeightedBackendService, URLMapDefaultRouteActionWeightedBackendServiceArgs
- Backend
Service string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- Header
Action URLMapDefault Route Action Weighted Backend Service Header Action 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.
- 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
- Backend
Service string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- Header
Action URLMapDefault Route Action Weighted Backend Service Header Action 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.
- 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
- backend
Service String The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header
Action URLMapDefault Route Action Weighted Backend Service Header Action 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.
- weight Integer
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000
- backend
Service string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header
Action URLMapDefault Route Action Weighted Backend Service Header Action 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.
- 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
- backend_
service str The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header_
action URLMapDefault Route Action Weighted Backend Service Header Action 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.
- 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
- backend
Service String The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header
Action Property Map 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.
- 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
URLMapDefaultRouteActionWeightedBackendServiceHeaderAction, URLMapDefaultRouteActionWeightedBackendServiceHeaderActionArgs
- Request
Headers List<URLMapTo Adds Default Route Action Weighted Backend Service Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers List<string>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers List<URLMapTo Adds Default Route Action Weighted Backend Service Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers List<string>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- Request
Headers []URLMapTo Adds Default Route Action Weighted Backend Service Header Action Request Headers To Add Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers []stringTo Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers []URLMapTo Adds Default Route Action Weighted Backend Service Header Action Response Headers To Add Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers []stringTo Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<URLMapTo Adds Default Route Action Weighted Backend Service Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<URLMapTo Adds Default Route Action Weighted Backend Service Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers URLMapTo Adds Default Route Action Weighted Backend Service Header Action Request Headers To Add[] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers string[]To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers URLMapTo Adds Default Route Action Weighted Backend Service Header Action Response Headers To Add[] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers string[]To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request_
headers_ Sequence[URLMapto_ adds Default Route Action Weighted Backend Service Header Action Request Headers To Add] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response_
headers_ Sequence[URLMapto_ adds Default Route Action Weighted Backend Service Header Action Response Headers To Add] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<Property Map>To Adds Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<Property Map>To Adds Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
URLMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd, URLMapDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd, URLMapDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapDefaultUrlRedirect, URLMapDefaultUrlRedirectArgs
- Strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- Host
Redirect string The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- Https
Redirect 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.
- Path
Redirect string The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Prefix
Redirect string The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Redirect
Response stringCode 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.
- Strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- Host
Redirect string The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- Https
Redirect 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.
- Path
Redirect string The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Prefix
Redirect string The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Redirect
Response stringCode 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.
- strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host
Redirect String The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- https
Redirect Boolean If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
- path
Redirect String The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- prefix
Redirect String The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- redirect
Response StringCode 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.
- strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host
Redirect string The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- https
Redirect boolean If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
- path
Redirect string The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- prefix
Redirect string The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- redirect
Response stringCode 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.
- strip_
query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host_
redirect 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.
- https_
redirect 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.
- path_
redirect 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.
- prefix_
redirect 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.
- redirect_
response_ strcode 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.
- strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host
Redirect String The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- https
Redirect Boolean If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
- path
Redirect String The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- prefix
Redirect String The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- redirect
Response StringCode 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.
URLMapHeaderAction, URLMapHeaderActionArgs
- Request
Headers List<URLMapTo Adds Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers List<string>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers List<URLMapTo Adds Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers List<string>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- Request
Headers []URLMapTo Adds Header Action Request Headers To Add Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers []stringTo Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers []URLMapTo Adds Header Action Response Headers To Add Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers []stringTo Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<URLMapTo Adds Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<URLMapTo Adds Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers URLMapTo Adds Header Action Request Headers To Add[] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers string[]To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers URLMapTo Adds Header Action Response Headers To Add[] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers string[]To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request_
headers_ Sequence[URLMapto_ adds Header Action Request Headers To Add] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response_
headers_ Sequence[URLMapto_ adds Header Action Response Headers To Add] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<Property Map>To Adds Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<Property Map>To Adds Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
URLMapHeaderActionRequestHeadersToAdd, URLMapHeaderActionRequestHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapHeaderActionResponseHeadersToAdd, URLMapHeaderActionResponseHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapHostRule, URLMapHostRuleArgs
- 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 ..
- Path
Matcher 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
An optional description of this resource. Provide this property when you create the resource.
- 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 ..
- Path
Matcher 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
An optional description of this resource. Provide this property when you create the resource.
- 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 ..
- path
Matcher 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
An optional description of this resource. Provide this property when you create the resource.
- 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 ..
- path
Matcher 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
An optional description of this resource. Provide this property when you create the resource.
- hosts Sequence[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 ..
- path_
matcher 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
An optional description of this resource. Provide this property when you create the resource.
- 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 ..
- path
Matcher 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
An optional description of this resource. Provide this property when you create the resource.
URLMapPathMatcher, URLMapPathMatcherArgs
- Name string
The name to which this PathMatcher is referred by the HostRule.
- Default
Route URLMapAction Path Matcher Default Route Action defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- Default
Service string The backend service or backend bucket to use when none of the given paths match.
- Default
Url URLMapRedirect Path Matcher Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- Header
Action URLMapPath Matcher Header Action Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.
- Path
Rules List<URLMapPath Matcher Path Rule> 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.
- Route
Rules List<URLMapPath Matcher Route Rule> 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.
- Name string
The name to which this PathMatcher is referred by the HostRule.
- Default
Route URLMapAction Path Matcher Default Route Action defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- Default
Service string The backend service or backend bucket to use when none of the given paths match.
- Default
Url URLMapRedirect Path Matcher Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- Header
Action URLMapPath Matcher Header Action Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.
- Path
Rules []URLMapPath Matcher Path Rule 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.
- Route
Rules []URLMapPath Matcher Route Rule 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.
- name String
The name to which this PathMatcher is referred by the HostRule.
- default
Route URLMapAction Path Matcher Default Route Action defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service String The backend service or backend bucket to use when none of the given paths match.
- default
Url URLMapRedirect Path Matcher Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- header
Action URLMapPath Matcher Header Action Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.
- path
Rules List<URLMapPath Matcher Path Rule> 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.
- route
Rules List<URLMapPath Matcher Route Rule> 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.
- name string
The name to which this PathMatcher is referred by the HostRule.
- default
Route URLMapAction Path Matcher Default Route Action defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service string The backend service or backend bucket to use when none of the given paths match.
- default
Url URLMapRedirect Path Matcher Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- header
Action URLMapPath Matcher Header Action Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.
- path
Rules URLMapPath Matcher Path Rule[] 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.
- route
Rules URLMapPath Matcher Route Rule[] 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.
- name str
The name to which this PathMatcher is referred by the HostRule.
- default_
route_ URLMapaction Path Matcher Default Route Action defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default_
service str The backend service or backend bucket to use when none of the given paths match.
- default_
url_ URLMapredirect Path Matcher Default Url Redirect 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
An optional description of this resource. Provide this property when you create the resource.
- header_
action URLMapPath Matcher Header Action Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.
- path_
rules Sequence[URLMapPath Matcher Path Rule] 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.
- route_
rules Sequence[URLMapPath Matcher Route Rule] 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.
- name String
The name to which this PathMatcher is referred by the HostRule.
- default
Route Property MapAction defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
- default
Service String The backend service or backend bucket to use when none of the given paths match.
- default
Url Property MapRedirect 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
An optional description of this resource. Provide this property when you create the resource.
- header
Action Property Map Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Structure is documented below.
- path
Rules List<Property Map> 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.
- route
Rules List<Property Map> 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.
URLMapPathMatcherDefaultRouteAction, URLMapPathMatcherDefaultRouteActionArgs
- Cors
Policy URLMapPath Matcher Default Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- Fault
Injection URLMapPolicy Path Matcher Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- Request
Mirror URLMapPolicy Path Matcher Default Route Action Request Mirror Policy 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.
- Retry
Policy URLMapPath Matcher Default Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- Timeout
URLMap
Path Matcher Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Url
Rewrite URLMapPath Matcher Default Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- Weighted
Backend List<URLMapServices Path Matcher Default Route Action Weighted Backend Service> 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.
- Cors
Policy URLMapPath Matcher Default Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- Fault
Injection URLMapPolicy Path Matcher Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- Request
Mirror URLMapPolicy Path Matcher Default Route Action Request Mirror Policy 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.
- Retry
Policy URLMapPath Matcher Default Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- Timeout
URLMap
Path Matcher Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Url
Rewrite URLMapPath Matcher Default Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- Weighted
Backend []URLMapServices Path Matcher Default Route Action Weighted Backend Service 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.
- cors
Policy URLMapPath Matcher Default Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection URLMapPolicy Path Matcher Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request
Mirror URLMapPolicy Path Matcher Default Route Action Request Mirror Policy 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.
- retry
Policy URLMapPath Matcher Default Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Path Matcher Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url
Rewrite URLMapPath Matcher Default Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted
Backend List<URLMapServices Path Matcher Default Route Action Weighted Backend Service> 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.
- cors
Policy URLMapPath Matcher Default Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection URLMapPolicy Path Matcher Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request
Mirror URLMapPolicy Path Matcher Default Route Action Request Mirror Policy 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.
- retry
Policy URLMapPath Matcher Default Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Path Matcher Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url
Rewrite URLMapPath Matcher Default Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted
Backend URLMapServices Path Matcher Default Route Action Weighted Backend Service[] 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.
- cors_
policy URLMapPath Matcher Default Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault_
injection_ URLMappolicy Path Matcher Default Route Action Fault Injection Policy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request_
mirror_ URLMappolicy Path Matcher Default Route Action Request Mirror Policy 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.
- retry_
policy URLMapPath Matcher Default Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Path Matcher Default Route Action Timeout Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url_
rewrite URLMapPath Matcher Default Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted_
backend_ Sequence[URLMapservices Path Matcher Default Route Action Weighted Backend Service] 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.
- cors
Policy Property Map The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection Property MapPolicy The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy. Structure is documented below.
- request
Mirror Property MapPolicy 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.
- retry
Policy Property Map Specifies the retry policy associated with this route. Structure is documented below.
- timeout Property Map
Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- url
Rewrite Property Map The spec to modify the URL of the request, prior to forwarding the request to the matched service. Structure is documented below.
- weighted
Backend List<Property Map>Services 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.
URLMapPathMatcherDefaultRouteActionCorsPolicy, URLMapPathMatcherDefaultRouteActionCorsPolicyArgs
- Allow
Credentials 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.
- Allow
Headers List<string> Specifies the content for the Access-Control-Allow-Headers header.
- Allow
Methods List<string> Specifies the content for the Access-Control-Allow-Methods header.
- Allow
Origin List<string>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Allow
Origins List<string> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- Expose
Headers List<string> Specifies the content for the Access-Control-Expose-Headers header.
- Max
Age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- Allow
Credentials 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.
- Allow
Headers []string Specifies the content for the Access-Control-Allow-Headers header.
- Allow
Methods []string Specifies the content for the Access-Control-Allow-Methods header.
- Allow
Origin []stringRegexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Allow
Origins []string Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- Expose
Headers []string Specifies the content for the Access-Control-Expose-Headers header.
- Max
Age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow
Credentials 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.
- allow
Headers List<String> Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods List<String> Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin List<String>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins List<String> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled Boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose
Headers List<String> Specifies the content for the Access-Control-Expose-Headers header.
- max
Age Integer Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow
Credentials 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.
- allow
Headers string[] Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods string[] Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin string[]Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins string[] Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose
Headers string[] Specifies the content for the Access-Control-Expose-Headers header.
- max
Age number Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow_
credentials 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.
- allow_
headers Sequence[str] Specifies the content for the Access-Control-Allow-Headers header.
- allow_
methods Sequence[str] Specifies the content for the Access-Control-Allow-Methods header.
- allow_
origin_ Sequence[str]regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow_
origins Sequence[str] Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose_
headers Sequence[str] Specifies the content for the Access-Control-Expose-Headers header.
- max_
age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- allow
Credentials 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.
- allow
Headers List<String> Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods List<String> Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin List<String>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins List<String> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- disabled Boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- expose
Headers List<String> Specifies the content for the Access-Control-Expose-Headers header.
- max
Age Number Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
URLMapPathMatcherDefaultRouteActionFaultInjectionPolicy, URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyArgs
- Abort
URLMap
Path Matcher Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- Delay
URLMap
Path Matcher Default Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- Delay
URLMap
Path Matcher Default Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Path Matcher Default Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Path Matcher Default Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Default Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Path Matcher Default Route Action Fault Injection Policy Delay 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 Property Map
The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay Property Map
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.
URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbort, URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyAbortArgs
- Http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- Http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status Integer 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http_
status int 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelay, URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayArgs
- Fixed
Delay URLMapPath Matcher Default Route Action Fault Injection Policy Delay Fixed Delay 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.
- Fixed
Delay URLMapPath Matcher Default Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay URLMapPath Matcher Default Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay URLMapPath Matcher Default Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed_
delay URLMapPath Matcher Default Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay Property Map 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.
URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelay, URLMapPathMatcherDefaultRouteActionFaultInjectionPolicyDelayFixedDelayArgs
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 str
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
URLMapPathMatcherDefaultRouteActionRequestMirrorPolicy, URLMapPathMatcherDefaultRouteActionRequestMirrorPolicyArgs
- Backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- Backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- backend
Service String The full or partial URL to the BackendService resource being mirrored to.
- backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- backend_
service str The full or partial URL to the BackendService resource being mirrored to.
- backend
Service String The full or partial URL to the BackendService resource being mirrored to.
URLMapPathMatcherDefaultRouteActionRetryPolicy, URLMapPathMatcherDefaultRouteActionRetryPolicyArgs
- Num
Retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Per
Try URLMapTimeout Path Matcher Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Retry
Conditions List<string> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- Num
Retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Per
Try URLMapTimeout Path Matcher Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Retry
Conditions []string Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries Integer Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try URLMapTimeout Path Matcher Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions List<String> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries number Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try URLMapTimeout Path Matcher Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions string[] Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num_
retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per_
try_ URLMaptimeout Path Matcher Default Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry_
conditions Sequence[str] Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries Number Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try Property MapTimeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions List<String> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
URLMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeout, URLMapPathMatcherDefaultRouteActionRetryPolicyPerTryTimeoutArgs
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 str
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
URLMapPathMatcherDefaultRouteActionTimeout, URLMapPathMatcherDefaultRouteActionTimeoutArgs
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 str
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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 String
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
URLMapPathMatcherDefaultRouteActionUrlRewrite, URLMapPathMatcherDefaultRouteActionUrlRewriteArgs
- Host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- Path
Prefix stringRewrite 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.
- Host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- Path
Prefix stringRewrite 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.
- host
Rewrite String Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix StringRewrite 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.
- host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix stringRewrite 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.
- host_
rewrite 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.
- path_
prefix_ strrewrite 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.
- host
Rewrite String Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix StringRewrite 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.
URLMapPathMatcherDefaultRouteActionWeightedBackendService, URLMapPathMatcherDefaultRouteActionWeightedBackendServiceArgs
- Backend
Service string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- Header
Action URLMapPath Matcher Default Route Action Weighted Backend Service Header Action 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.
- 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
- Backend
Service string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- Header
Action URLMapPath Matcher Default Route Action Weighted Backend Service Header Action 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.
- 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
- backend
Service String The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header
Action URLMapPath Matcher Default Route Action Weighted Backend Service Header Action 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.
- weight Integer
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000
- backend
Service string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header
Action URLMapPath Matcher Default Route Action Weighted Backend Service Header Action 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.
- 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
- backend_
service str The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header_
action URLMapPath Matcher Default Route Action Weighted Backend Service Header Action 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.
- 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
- backend
Service String The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- header
Action Property Map 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.
- 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
URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderAction, URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionArgs
- Request
Headers List<URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers List<string>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers List<URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers List<string>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- Request
Headers []URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Request Headers To Add Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers []stringTo Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers []URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Response Headers To Add Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers []stringTo Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Request Headers To Add[] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers string[]To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers URLMapTo Adds Path Matcher Default Route Action Weighted Backend Service Header Action Response Headers To Add[] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers string[]To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request_
headers_ Sequence[URLMapto_ adds Path Matcher Default Route Action Weighted Backend Service Header Action Request Headers To Add] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response_
headers_ Sequence[URLMapto_ adds Path Matcher Default Route Action Weighted Backend Service Header Action Response Headers To Add] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<Property Map>To Adds Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<Property Map>To Adds Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd, URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAdd, URLMapPathMatcherDefaultRouteActionWeightedBackendServiceHeaderActionResponseHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapPathMatcherDefaultUrlRedirect, URLMapPathMatcherDefaultUrlRedirectArgs
- Strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- Host
Redirect string The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- Https
Redirect 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.
- Path
Redirect string The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Prefix
Redirect string The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Redirect
Response stringCode 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.
- Strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- Host
Redirect string The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- Https
Redirect 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.
- Path
Redirect string The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Prefix
Redirect string The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- Redirect
Response stringCode 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.
- strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host
Redirect String The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- https
Redirect Boolean If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
- path
Redirect String The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- prefix
Redirect String The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- redirect
Response StringCode 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.
- strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host
Redirect string The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- https
Redirect boolean If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
- path
Redirect string The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- prefix
Redirect string The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- redirect
Response stringCode 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.
- strip_
query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host_
redirect 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.
- https_
redirect 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.
- path_
redirect 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.
- prefix_
redirect 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.
- redirect_
response_ strcode 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.
- strip
Query 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. The default is set to false. This field is required to ensure an empty block is not set. The normal default value is false.
- host
Redirect String The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.
- https
Redirect Boolean If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
- path
Redirect String The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- prefix
Redirect String The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.
- redirect
Response StringCode 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.
URLMapPathMatcherHeaderAction, URLMapPathMatcherHeaderActionArgs
- Request
Headers List<URLMapTo Adds Path Matcher Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers List<string>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers List<URLMapTo Adds Path Matcher Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers List<string>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- Request
Headers []URLMapTo Adds Path Matcher Header Action Request Headers To Add Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers []stringTo Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers []URLMapTo Adds Path Matcher Header Action Response Headers To Add Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers []stringTo Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<URLMapTo Adds Path Matcher Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<URLMapTo Adds Path Matcher Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers URLMapTo Adds Path Matcher Header Action Request Headers To Add[] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers string[]To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers URLMapTo Adds Path Matcher Header Action Response Headers To Add[] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers string[]To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request_
headers_ Sequence[URLMapto_ adds Path Matcher Header Action Request Headers To Add] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response_
headers_ Sequence[URLMapto_ adds Path Matcher Header Action Response Headers To Add] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<Property Map>To Adds Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<Property Map>To Adds Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
URLMapPathMatcherHeaderActionRequestHeadersToAdd, URLMapPathMatcherHeaderActionRequestHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapPathMatcherHeaderActionResponseHeadersToAdd, URLMapPathMatcherHeaderActionResponseHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value 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.
- header
Name String The name of the header to add.
- header
Value 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.
- header
Name string The name of the header to add.
- header
Value 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.
- header_
name str The name of the header to add.
- header_
value 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.
- header
Name String The name of the header to add.
- header
Value 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.
URLMapPathMatcherPathRule, URLMapPathMatcherPathRuleArgs
- 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.
- Route
Action URLMapPath Matcher Path Rule Route Action 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
The backend service or backend bucket to use if any of the given paths match.
- Url
Redirect URLMapPath Matcher Path Rule Url Redirect 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.
- Route
Action URLMapPath Matcher Path Rule Route Action 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
The backend service or backend bucket to use if any of the given paths match.
- Url
Redirect URLMapPath Matcher Path Rule Url Redirect 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<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.
- route
Action URLMapPath Matcher Path Rule Route Action 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
The backend service or backend bucket to use if any of the given paths match.
- url
Redirect URLMapPath Matcher Path Rule Url Redirect 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.
- route
Action URLMapPath Matcher Path Rule Route Action 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
The backend service or backend bucket to use if any of the given paths match.
- url
Redirect URLMapPath Matcher Path Rule Url Redirect 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 Sequence[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.
- route_
action URLMapPath Matcher Path Rule Route Action 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
The backend service or backend bucket to use if any of the given paths match.
- url_
redirect URLMapPath Matcher Path Rule Url Redirect 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<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.
- route
Action Property Map 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
The backend service or backend bucket to use if any of the given paths match.
- url
Redirect Property Map 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.
URLMapPathMatcherPathRuleRouteAction, URLMapPathMatcherPathRuleRouteActionArgs
- Cors
Policy URLMapPath Matcher Path Rule Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- Fault
Injection URLMapPolicy Path Matcher Path Rule Route Action Fault Injection Policy 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.
- Request
Mirror URLMapPolicy Path Matcher Path Rule Route Action Request Mirror Policy 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.
- Retry
Policy URLMapPath Matcher Path Rule Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- Timeout
URLMap
Path Matcher Path Rule Route Action Timeout 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.
- Url
Rewrite URLMapPath Matcher Path Rule Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.
- Weighted
Backend List<URLMapServices Path Matcher Path Rule Route Action Weighted Backend Service> 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.
- Cors
Policy URLMapPath Matcher Path Rule Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- Fault
Injection URLMapPolicy Path Matcher Path Rule Route Action Fault Injection Policy 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.
- Request
Mirror URLMapPolicy Path Matcher Path Rule Route Action Request Mirror Policy 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.
- Retry
Policy URLMapPath Matcher Path Rule Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- Timeout
URLMap
Path Matcher Path Rule Route Action Timeout 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.
- Url
Rewrite URLMapPath Matcher Path Rule Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.
- Weighted
Backend []URLMapServices Path Matcher Path Rule Route Action Weighted Backend Service 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.
- cors
Policy URLMapPath Matcher Path Rule Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection URLMapPolicy Path Matcher Path Rule Route Action Fault Injection Policy 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.
- request
Mirror URLMapPolicy Path Matcher Path Rule Route Action Request Mirror Policy 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.
- retry
Policy URLMapPath Matcher Path Rule Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Path Matcher Path Rule Route Action Timeout 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.
- url
Rewrite URLMapPath Matcher Path Rule Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.
- weighted
Backend List<URLMapServices Path Matcher Path Rule Route Action Weighted Backend Service> 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.
- cors
Policy URLMapPath Matcher Path Rule Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection URLMapPolicy Path Matcher Path Rule Route Action Fault Injection Policy 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.
- request
Mirror URLMapPolicy Path Matcher Path Rule Route Action Request Mirror Policy 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.
- retry
Policy URLMapPath Matcher Path Rule Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Path Matcher Path Rule Route Action Timeout 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.
- url
Rewrite URLMapPath Matcher Path Rule Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.
- weighted
Backend URLMapServices Path Matcher Path Rule Route Action Weighted Backend Service[] 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.
- cors_
policy URLMapPath Matcher Path Rule Route Action Cors Policy The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault_
injection_ URLMappolicy Path Matcher Path Rule Route Action Fault Injection Policy 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.
- request_
mirror_ URLMappolicy Path Matcher Path Rule Route Action Request Mirror Policy 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.
- retry_
policy URLMapPath Matcher Path Rule Route Action Retry Policy Specifies the retry policy associated with this route. Structure is documented below.
- timeout
URLMap
Path Matcher Path Rule Route Action Timeout 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.
- url_
rewrite URLMapPath Matcher Path Rule Route Action Url Rewrite The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.
- weighted_
backend_ Sequence[URLMapservices Path Matcher Path Rule Route Action Weighted Backend Service] 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.
- cors
Policy Property Map The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.
- fault
Injection Property MapPolicy 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.
- request
Mirror Property MapPolicy 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.
- retry
Policy Property Map Specifies the retry policy associated with this route. Structure is documented below.
- timeout Property Map
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.
- url
Rewrite Property Map The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.
- weighted
Backend List<Property Map>Services 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.
URLMapPathMatcherPathRuleRouteActionCorsPolicy, URLMapPathMatcherPathRuleRouteActionCorsPolicyArgs
- Disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- Allow
Credentials 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.
- Allow
Headers List<string> Specifies the content for the Access-Control-Allow-Headers header.
- Allow
Methods List<string> Specifies the content for the Access-Control-Allow-Methods header.
- Allow
Origin List<string>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Allow
Origins List<string> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Expose
Headers List<string> Specifies the content for the Access-Control-Expose-Headers header.
- Max
Age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- Disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- Allow
Credentials 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.
- Allow
Headers []string Specifies the content for the Access-Control-Allow-Headers header.
- Allow
Methods []string Specifies the content for the Access-Control-Allow-Methods header.
- Allow
Origin []stringRegexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Allow
Origins []string Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- Expose
Headers []string Specifies the content for the Access-Control-Expose-Headers header.
- Max
Age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- disabled Boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- allow
Credentials 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.
- allow
Headers List<String> Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods List<String> Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin List<String>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins List<String> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- expose
Headers List<String> Specifies the content for the Access-Control-Expose-Headers header.
- max
Age Integer Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- disabled boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- allow
Credentials 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.
- allow
Headers string[] Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods string[] Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin string[]Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins string[] Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- expose
Headers string[] Specifies the content for the Access-Control-Expose-Headers header.
- max
Age number Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- disabled bool
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- allow_
credentials 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.
- allow_
headers Sequence[str] Specifies the content for the Access-Control-Allow-Headers header.
- allow_
methods Sequence[str] Specifies the content for the Access-Control-Allow-Methods header.
- allow_
origin_ Sequence[str]regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow_
origins Sequence[str] Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- expose_
headers Sequence[str] Specifies the content for the Access-Control-Expose-Headers header.
- max_
age int Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
- disabled Boolean
If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
- allow
Credentials 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.
- allow
Headers List<String> Specifies the content for the Access-Control-Allow-Headers header.
- allow
Methods List<String> Specifies the content for the Access-Control-Allow-Methods header.
- allow
Origin List<String>Regexes Specifies the regular expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- allow
Origins List<String> Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.
- expose
Headers List<String> Specifies the content for the Access-Control-Expose-Headers header.
- max
Age Number Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicy, URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyArgs
- Abort
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- Delay
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- Delay
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Delay 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
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Abort The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay
URLMap
Path Matcher Path Rule Route Action Fault Injection Policy Delay 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 Property Map
The specification for how client requests are aborted as part of fault injection. Structure is documented below.
- delay Property Map
The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.
URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort, URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbortArgs
- Http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- Http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status Integer 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http_
status int 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
- http
Status 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) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.
URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay, URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayArgs
- Fixed
Delay URLMapPath Matcher Path Rule Route Action Fault Injection Policy Delay Fixed Delay 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.
- Fixed
Delay URLMapPath Matcher Path Rule Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay URLMapPath Matcher Path Rule Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay URLMapPath Matcher Path Rule Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed_
delay URLMapPath Matcher Path Rule Route Action Fault Injection Policy Delay Fixed Delay 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.
- fixed
Delay Property Map 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.
URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay, URLMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelayArgs
- Seconds string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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.
URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicy, URLMapPathMatcherPathRuleRouteActionRequestMirrorPolicyArgs
- Backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- Backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- backend
Service String The full or partial URL to the BackendService resource being mirrored to.
- backend
Service string The full or partial URL to the BackendService resource being mirrored to.
- backend_
service str The full or partial URL to the BackendService resource being mirrored to.
- backend
Service String The full or partial URL to the BackendService resource being mirrored to.
URLMapPathMatcherPathRuleRouteActionRetryPolicy, URLMapPathMatcherPathRuleRouteActionRetryPolicyArgs
- Num
Retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Per
Try URLMapTimeout Path Matcher Path Rule Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Retry
Conditions List<string> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- Num
Retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Per
Try URLMapTimeout Path Matcher Path Rule Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- Retry
Conditions []string Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries Integer Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try URLMapTimeout Path Matcher Path Rule Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions List<String> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries number Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try URLMapTimeout Path Matcher Path Rule Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions string[] Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num_
retries int Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per_
try_ URLMaptimeout Path Matcher Path Rule Route Action Retry Policy Per Try Timeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry_
conditions Sequence[str] Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
- num
Retries Number Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- per
Try Property MapTimeout Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. Structure is documented below.
- retry
Conditions List<String> Specfies one or more conditions when this retry rule applies. Valid values are:
- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout,
- connection failure, and refused streams.
- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.
- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.
- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.
- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
- cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled
- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded
- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted
- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable
URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout, URLMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeoutArgs
- Seconds string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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.
URLMapPathMatcherPathRuleRouteActionTimeout, URLMapPathMatcherPathRuleRouteActionTimeoutArgs
- Seconds string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- nanos Integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
- seconds string
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- 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.
URLMapPathMatcherPathRuleRouteActionUrlRewrite, URLMapPathMatcherPathRuleRouteActionUrlRewriteArgs
- Host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- Path
Prefix stringRewrite 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.
- Host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- Path
Prefix stringRewrite 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.
- host
Rewrite String Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix StringRewrite 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.
- host
Rewrite string Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix stringRewrite 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.
- host_
rewrite 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.
- path_
prefix_ strrewrite 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.
- host
Rewrite String Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.
- path
Prefix StringRewrite 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.
URLMapPathMatcherPathRuleRouteActionWeightedBackendService, URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceArgs
- Backend
Service string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- 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
- Header
Action URLMapPath Matcher Path Rule Route Action Weighted Backend Service Header Action 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 string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- 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
- Header
Action URLMapPath Matcher Path Rule Route Action Weighted Backend Service Header Action 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 String The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- weight Integer
Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000
- header
Action URLMapPath Matcher Path Rule Route Action Weighted Backend Service Header Action 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 string The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- 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
- header
Action URLMapPath Matcher Path Rule Route Action Weighted Backend Service Header Action 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 full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- 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
- header_
action URLMapPath Matcher Path Rule Route Action Weighted Backend Service Header Action 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 String The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.
- 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
- header
Action Property Map 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.
URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction, URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionArgs
- Request
Headers List<URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers List<string>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers List<URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers List<string>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- Request
Headers []URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Request Headers To Add Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- Request
Headers []stringTo Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- Response
Headers []URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Response Headers To Add Headers to add the response prior to sending the response back to the client. Structure is documented below.
- Response
Headers []stringTo Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Request Headers To Add> Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Response Headers To Add> Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Request Headers To Add[] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers string[]To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers URLMapTo Adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Response Headers To Add[] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers string[]To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request_
headers_ Sequence[URLMapto_ adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Request Headers To Add] Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response_
headers_ Sequence[URLMapto_ adds Path Matcher Path Rule Route Action Weighted Backend Service Header Action Response Headers To Add] Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response_
headers_ Sequence[str]to_ removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
- request
Headers List<Property Map>To Adds Headers to add to a matching request prior to forwarding the request to the backendService. Structure is documented below.
- request
Headers List<String>To Removes A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.
- response
Headers List<Property Map>To Adds Headers to add the response prior to sending the response back to the client. Structure is documented below.
- response
Headers List<String>To Removes A list of header names for headers that need to be removed from the response prior to sending the response back to the client.
URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd, URLMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAddArgs
- Header
Name string The name of the header to add.
- Header
Value 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.
- Header
Name string The name of the header to add.
- Header
Value string