UrlMapArgs

data class UrlMapArgs(val defaultRouteAction: Output<HttpRouteActionArgs>? = null, val defaultService: Output<String>? = null, val defaultUrlRedirect: Output<HttpRedirectActionArgs>? = null, val description: Output<String>? = null, val headerAction: Output<HttpHeaderActionArgs>? = null, val hostRules: Output<List<HostRuleArgs>>? = null, val name: Output<String>? = null, val pathMatchers: Output<List<PathMatcherArgs>>? = null, val project: Output<String>? = null, val requestId: Output<String>? = null, val tests: Output<List<UrlMapTestArgs>>? = null) : ConvertibleToJava<UrlMapArgs>

Creates a UrlMap resource in the specified project using the data included in the request.

Constructors

Link copied to clipboard
fun UrlMapArgs(defaultRouteAction: Output<HttpRouteActionArgs>? = null, defaultService: Output<String>? = null, defaultUrlRedirect: Output<HttpRedirectActionArgs>? = null, description: Output<String>? = null, headerAction: Output<HttpHeaderActionArgs>? = null, hostRules: Output<List<HostRuleArgs>>? = null, name: Output<String>? = null, pathMatchers: Output<List<PathMatcherArgs>>? = null, project: Output<String>? = null, requestId: Output<String>? = null, tests: Output<List<UrlMapTestArgs>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): UrlMapArgs

Properties

Link copied to clipboard

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. 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. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

Link copied to clipboard
val defaultService: Output<String>? = null

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

Link copied to clipboard

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. Not supported when the URL map is bound to a target gRPC proxy.

Link copied to clipboard
val description: Output<String>? = null

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

Link copied to clipboard
val headerAction: Output<HttpHeaderActionArgs>? = null

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. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Link copied to clipboard
val hostRules: Output<List<HostRuleArgs>>? = null

The list of host rules to use against the URL.

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val pathMatchers: Output<List<PathMatcherArgs>>? = null

The list of named PathMatchers to use against the URL.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val requestId: Output<String>? = null

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Link copied to clipboard
val tests: Output<List<UrlMapTestArgs>>? = null

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.