ComputeURLMap

Property Value
Google Cloud Service Name Compute Engine
Google Cloud Service Documentation /compute/docs/
Google Cloud REST Resource Name v1.urlMaps
Google Cloud REST Resource Documentation /compute/docs/reference/rest/v1/urlMaps
Config Connector Resource Short Names gcpcomputeurlmap
gcpcomputeurlmaps
computeurlmap
Config Connector Service Name compute.googleapis.com
Config Connector Resource Fully Qualified Name computeurlmaps.compute.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id

Spec

Schema

defaultService:
  backendBucketRef:
    external: string
    name: string
    namespace: string
  backendServiceRef:
    external: string
    name: string
    namespace: string
defaultUrlRedirect:
  hostRedirect: string
  httpsRedirect: boolean
  pathRedirect: string
  prefixRedirect: string
  redirectResponseCode: string
  stripQuery: boolean
description: string
headerAction:
  requestHeadersToAdd:
  - headerName: string
    headerValue: string
    replace: boolean
  requestHeadersToRemove:
  - string
  responseHeadersToAdd:
  - headerName: string
    headerValue: string
    replace: boolean
  responseHeadersToRemove:
  - string
hostRule:
- description: string
  hosts:
  - string
  pathMatcher: string
location: string
pathMatcher:
- defaultService:
    backendBucketRef:
      external: string
      name: string
      namespace: string
    backendServiceRef:
      external: string
      name: string
      namespace: string
  defaultUrlRedirect:
    hostRedirect: string
    httpsRedirect: boolean
    pathRedirect: string
    prefixRedirect: string
    redirectResponseCode: string
    stripQuery: boolean
  description: string
  headerAction:
    requestHeadersToAdd:
    - headerName: string
      headerValue: string
      replace: boolean
    requestHeadersToRemove:
    - string
    responseHeadersToAdd:
    - headerName: string
      headerValue: string
      replace: boolean
    responseHeadersToRemove:
    - string
  name: string
  pathRule:
  - paths:
    - string
    routeAction:
      corsPolicy:
        allowCredentials: boolean
        allowHeaders:
        - string
        allowMethods:
        - string
        allowOriginRegexes:
        - string
        allowOrigins:
        - string
        disabled: boolean
        exposeHeaders:
        - string
        maxAge: integer
      faultInjectionPolicy:
        abort:
          httpStatus: integer
          percentage: float
        delay:
          fixedDelay:
            nanos: integer
            seconds: string
          percentage: float
      requestMirrorPolicy:
        backendService: string
      retryPolicy:
        numRetries: integer
        perTryTimeout:
          nanos: integer
          seconds: string
        retryConditions:
        - string
      timeout:
        nanos: integer
        seconds: string
      urlRewrite:
        hostRewrite: string
        pathPrefixRewrite: string
      weightedBackendServices:
      - backendServiceRef:
          external: string
          name: string
          namespace: string
        headerAction:
          requestHeadersToAdd:
          - headerName: string
            headerValue: string
            replace: boolean
          requestHeadersToRemove:
          - string
          responseHeadersToAdd:
          - headerName: string
            headerValue: string
            replace: boolean
          responseHeadersToRemove:
          - string
        weight: integer
    service:
      backendBucketRef:
        external: string
        name: string
        namespace: string
      backendServiceRef:
        external: string
        name: string
        namespace: string
    urlRedirect:
      hostRedirect: string
      httpsRedirect: boolean
      pathRedirect: string
      prefixRedirect: string
      redirectResponseCode: string
      stripQuery: boolean
  routeRules:
  - headerAction:
      requestHeadersToAdd:
      - headerName: string
        headerValue: string
        replace: boolean
      requestHeadersToRemove:
      - string
      responseHeadersToAdd:
      - headerName: string
        headerValue: string
        replace: boolean
      responseHeadersToRemove:
      - string
    matchRules:
    - fullPathMatch: string
      headerMatches:
      - exactMatch: string
        headerName: string
        invertMatch: boolean
        prefixMatch: string
        presentMatch: boolean
        rangeMatch:
          rangeEnd: integer
          rangeStart: integer
        regexMatch: string
        suffixMatch: string
      ignoreCase: boolean
      metadataFilters:
      - filterLabels:
        - name: string
          value: string
        filterMatchCriteria: string
      prefixMatch: string
      queryParameterMatches:
      - exactMatch: string
        name: string
        presentMatch: boolean
        regexMatch: string
      regexMatch: string
    priority: integer
    routeAction:
      corsPolicy:
        allowCredentials: boolean
        allowHeaders:
        - string
        allowMethods:
        - string
        allowOriginRegexes:
        - string
        allowOrigins:
        - string
        disabled: boolean
        exposeHeaders:
        - string
        maxAge: integer
      faultInjectionPolicy:
        abort:
          httpStatus: integer
          percentage: float
        delay:
          fixedDelay:
            nanos: integer
            seconds: string
          percentage: float
      requestMirrorPolicy:
        backendService: string
      retryPolicy:
        numRetries: integer
        perTryTimeout:
          nanos: integer
          seconds: string
        retryConditions:
        - string
      timeout:
        nanos: integer
        seconds: string
      urlRewrite:
        hostRewrite: string
        pathPrefixRewrite: string
      weightedBackendServices:
      - backendServiceRef:
          external: string
          name: string
          namespace: string
        headerAction:
          requestHeadersToAdd:
          - headerName: string
            headerValue: string
            replace: boolean
          requestHeadersToRemove:
          - string
          responseHeadersToAdd:
          - headerName: string
            headerValue: string
            replace: boolean
          responseHeadersToRemove:
          - string
        weight: integer
    service: string
    urlRedirect:
      hostRedirect: string
      httpsRedirect: boolean
      pathRedirect: string
      prefixRedirect: string
      redirectResponseCode: string
      stripQuery: boolean
test:
- description: string
  host: string
  path: string
  service:
    backendBucketRef:
      external: string
      name: string
      namespace: string
    backendServiceRef:
      external: string
      name: string
      namespace: string
Fields

defaultService

Optional

object

The backend service or backend bucket to use when none of the given rules match.

defaultService.backendBucketRef

Optional

object

defaultService.backendBucketRef.external

Optional

string

The selfLink of a ComputeBackendBucket.

defaultService.backendBucketRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

defaultService.backendBucketRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

defaultService.backendServiceRef

Optional

object

defaultService.backendServiceRef.external

Optional

string

The selfLink of a ComputeBackendService.

defaultService.backendServiceRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

defaultService.backendServiceRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

defaultUrlRedirect

Optional

object

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.

defaultUrlRedirect.hostRedirect

Optional

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.

defaultUrlRedirect.httpsRedirect

Optional

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.

defaultUrlRedirect.pathRedirect

Optional

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.

defaultUrlRedirect.prefixRedirect

Optional

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.

defaultUrlRedirect.redirectResponseCode

Optional

string

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

defaultUrlRedirect.stripQuery

Required*

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.

description

Optional

string

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

headerAction

Optional

object

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

Optional

list (object)

headerAction.requestHeadersToAdd.[]

Optional

object

headerAction.requestHeadersToAdd.[].headerName

Required*

string

The name of the header.

headerAction.requestHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

headerAction.requestHeadersToAdd.[].replace

Required*

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.

headerAction.requestHeadersToRemove

Optional

list (string)

headerAction.requestHeadersToRemove.[]

Optional

string

headerAction.responseHeadersToAdd

Optional

list (object)

headerAction.responseHeadersToAdd.[]

Optional

object

headerAction.responseHeadersToAdd.[].headerName

Required*

string

The name of the header.

headerAction.responseHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

headerAction.responseHeadersToAdd.[].replace

Required*

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.

headerAction.responseHeadersToRemove

Optional

list (string)

headerAction.responseHeadersToRemove.[]

Optional

string

hostRule

Optional

list (object)

hostRule.[]

Optional

object

hostRule.[].description

Optional

string

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

hostRule.[].hosts

Required*

list (string)

hostRule.[].hosts.[]

Required*

string

hostRule.[].pathMatcher

Required*

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.

location

Required

string

Location represents the geographical location of the ComputeURLMap. Specify "global" for global resources.

pathMatcher

Optional

list (object)

pathMatcher.[]

Optional

object

pathMatcher.[].defaultService

Optional

object

The backend service or backend bucket to use when none of the given paths match.

pathMatcher.[].defaultService.backendBucketRef

Optional

object

pathMatcher.[].defaultService.backendBucketRef.external

Optional

string

The selfLink of a ComputeBackendBucket.

pathMatcher.[].defaultService.backendBucketRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

pathMatcher.[].defaultService.backendBucketRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

pathMatcher.[].defaultService.backendServiceRef

Optional

object

pathMatcher.[].defaultService.backendServiceRef.external

Optional

string

The selfLink of a ComputeBackendService.

pathMatcher.[].defaultService.backendServiceRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

pathMatcher.[].defaultService.backendServiceRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

pathMatcher.[].defaultUrlRedirect

Optional

object

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.

pathMatcher.[].defaultUrlRedirect.hostRedirect

Optional

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.

pathMatcher.[].defaultUrlRedirect.httpsRedirect

Optional

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.

pathMatcher.[].defaultUrlRedirect.pathRedirect

Optional

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.

pathMatcher.[].defaultUrlRedirect.prefixRedirect

Optional

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.

pathMatcher.[].defaultUrlRedirect.redirectResponseCode

Optional

string

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

pathMatcher.[].defaultUrlRedirect.stripQuery

Required*

boolean

If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. This field is required to ensure an empty block is not set. The normal default value is false.

pathMatcher.[].description

Optional

string

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

pathMatcher.[].headerAction

Optional

object

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

pathMatcher.[].headerAction.requestHeadersToAdd

Optional

list (object)

pathMatcher.[].headerAction.requestHeadersToAdd.[]

Optional

object

pathMatcher.[].headerAction.requestHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].headerAction.requestHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].headerAction.requestHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].headerAction.requestHeadersToRemove

Optional

list (string)

pathMatcher.[].headerAction.requestHeadersToRemove.[]

Optional

string

pathMatcher.[].headerAction.responseHeadersToAdd

Optional

list (object)

pathMatcher.[].headerAction.responseHeadersToAdd.[]

Optional

object

pathMatcher.[].headerAction.responseHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].headerAction.responseHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].headerAction.responseHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].headerAction.responseHeadersToRemove

Optional

list (string)

pathMatcher.[].headerAction.responseHeadersToRemove.[]

Optional

string

pathMatcher.[].name

Required*

string

The name to which this PathMatcher is referred by the HostRule.

pathMatcher.[].pathRule

Optional

list (object)

pathMatcher.[].pathRule.[]

Optional

object

pathMatcher.[].pathRule.[].paths

Required*

list (string)

pathMatcher.[].pathRule.[].paths.[]

Required*

string

pathMatcher.[].pathRule.[].routeAction

Optional

object

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.

pathMatcher.[].pathRule.[].routeAction.corsPolicy

Optional

object

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

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowCredentials

Optional

boolean

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

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowHeaders

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowHeaders.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowMethods

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowMethods.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowOriginRegexes

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowOriginRegexes.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowOrigins

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.corsPolicy.allowOrigins.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.corsPolicy.disabled

Required*

boolean

If true, specifies the CORS policy is disabled.

pathMatcher.[].pathRule.[].routeAction.corsPolicy.exposeHeaders

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.corsPolicy.exposeHeaders.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.corsPolicy.maxAge

Optional

integer

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

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy

Optional

object

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.

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.abort

Optional

object

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

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.abort.httpStatus

Required*

integer

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

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.abort.percentage

Required*

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.

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.delay

Optional

object

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

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.delay.fixedDelay

Required*

object

Specifies the value of the fixed delay interval.

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.delay.fixedDelay.nanos

Optional

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.

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.delay.fixedDelay.seconds

Required*

string

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

pathMatcher.[].pathRule.[].routeAction.faultInjectionPolicy.delay.percentage

Required*

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.

pathMatcher.[].pathRule.[].routeAction.requestMirrorPolicy

Optional

object

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.

pathMatcher.[].pathRule.[].routeAction.requestMirrorPolicy.backendService

Required*

string

The BackendService resource being mirrored to.

pathMatcher.[].pathRule.[].routeAction.retryPolicy

Optional

object

Specifies the retry policy associated with this route.

pathMatcher.[].pathRule.[].routeAction.retryPolicy.numRetries

Optional

integer

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

pathMatcher.[].pathRule.[].routeAction.retryPolicy.perTryTimeout

Optional

object

Specifies a non-zero timeout per retry attempt.

pathMatcher.[].pathRule.[].routeAction.retryPolicy.perTryTimeout.nanos

Optional

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.

pathMatcher.[].pathRule.[].routeAction.retryPolicy.perTryTimeout.seconds

Required*

string

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

pathMatcher.[].pathRule.[].routeAction.retryPolicy.retryConditions

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.retryPolicy.retryConditions.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.timeout

Optional

object

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.

pathMatcher.[].pathRule.[].routeAction.timeout.nanos

Optional

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.

pathMatcher.[].pathRule.[].routeAction.timeout.seconds

Required*

string

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

pathMatcher.[].pathRule.[].routeAction.urlRewrite

Optional

object

The spec to modify the URL of the request, prior to forwarding the request to the matched service

pathMatcher.[].pathRule.[].routeAction.urlRewrite.hostRewrite

Optional

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.

pathMatcher.[].pathRule.[].routeAction.urlRewrite.pathPrefixRewrite

Optional

string

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

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices

Optional

list (object)

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[]

Optional

object

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].backendServiceRef

Required*

object

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

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].backendServiceRef.external

Optional

string

The selfLink of a ComputeBackendService.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].backendServiceRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].backendServiceRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction

Optional

object

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.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd

Optional

list (object)

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[]

Optional

object

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToRemove

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToRemove.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd

Optional

list (object)

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[]

Optional

object

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToRemove

Optional

list (string)

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToRemove.[]

Optional

string

pathMatcher.[].pathRule.[].routeAction.weightedBackendServices.[].weight

Required*

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

pathMatcher.[].pathRule.[].service

Optional

object

The backend service or backend bucket to use if any of the given paths match.

pathMatcher.[].pathRule.[].service.backendBucketRef

Optional

object

pathMatcher.[].pathRule.[].service.backendBucketRef.external

Optional

string

The selfLink of a ComputeBackendBucket.

pathMatcher.[].pathRule.[].service.backendBucketRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

pathMatcher.[].pathRule.[].service.backendBucketRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

pathMatcher.[].pathRule.[].service.backendServiceRef

Optional

object

pathMatcher.[].pathRule.[].service.backendServiceRef.external

Optional

string

The selfLink of a ComputeBackendService.

pathMatcher.[].pathRule.[].service.backendServiceRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

pathMatcher.[].pathRule.[].service.backendServiceRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

pathMatcher.[].pathRule.[].urlRedirect

Optional

object

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.

pathMatcher.[].pathRule.[].urlRedirect.hostRedirect

Optional

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.

pathMatcher.[].pathRule.[].urlRedirect.httpsRedirect

Optional

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.

pathMatcher.[].pathRule.[].urlRedirect.pathRedirect

Optional

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.

pathMatcher.[].pathRule.[].urlRedirect.prefixRedirect

Optional

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.

pathMatcher.[].pathRule.[].urlRedirect.redirectResponseCode

Optional

string

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

pathMatcher.[].pathRule.[].urlRedirect.stripQuery

Required*

boolean

If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. This field is required to ensure an empty block is not set. The normal default value is false.

pathMatcher.[].routeRules

Optional

list (object)

pathMatcher.[].routeRules.[]

Optional

object

pathMatcher.[].routeRules.[].headerAction

Optional

object

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

pathMatcher.[].routeRules.[].headerAction.requestHeadersToAdd

Optional

list (object)

pathMatcher.[].routeRules.[].headerAction.requestHeadersToAdd.[]

Optional

object

pathMatcher.[].routeRules.[].headerAction.requestHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].routeRules.[].headerAction.requestHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].routeRules.[].headerAction.requestHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].routeRules.[].headerAction.requestHeadersToRemove

Optional

list (string)

pathMatcher.[].routeRules.[].headerAction.requestHeadersToRemove.[]

Optional

string

pathMatcher.[].routeRules.[].headerAction.responseHeadersToAdd

Optional

list (object)

pathMatcher.[].routeRules.[].headerAction.responseHeadersToAdd.[]

Optional

object

pathMatcher.[].routeRules.[].headerAction.responseHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].routeRules.[].headerAction.responseHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].routeRules.[].headerAction.responseHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].routeRules.[].headerAction.responseHeadersToRemove

Optional

list (string)

pathMatcher.[].routeRules.[].headerAction.responseHeadersToRemove.[]

Optional

string

pathMatcher.[].routeRules.[].matchRules

Optional

list (object)

pathMatcher.[].routeRules.[].matchRules.[]

Optional

object

pathMatcher.[].routeRules.[].matchRules.[].fullPathMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches

Optional

list (object)

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[]

Optional

object

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].exactMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].headerName

Required*

string

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].invertMatch

Optional

boolean

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].prefixMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].presentMatch

Optional

boolean

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].rangeMatch

Optional

object

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].rangeMatch.rangeEnd

Required*

integer

The end of the range (exclusive).

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].rangeMatch.rangeStart

Required*

integer

The start of the range (inclusive).

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].regexMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].headerMatches.[].suffixMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].ignoreCase

Optional

boolean

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

pathMatcher.[].routeRules.[].matchRules.[].metadataFilters

Optional

list (object)

pathMatcher.[].routeRules.[].matchRules.[].metadataFilters.[]

Optional

object

pathMatcher.[].routeRules.[].matchRules.[].metadataFilters.[].filterLabels

Required*

list (object)

pathMatcher.[].routeRules.[].matchRules.[].metadataFilters.[].filterLabels.[]

Required*

object

pathMatcher.[].routeRules.[].matchRules.[].metadataFilters.[].filterLabels.[].name

Required*

string

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

pathMatcher.[].routeRules.[].matchRules.[].metadataFilters.[].filterLabels.[].value

Required*

string

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

pathMatcher.[].routeRules.[].matchRules.[].metadataFilters.[].filterMatchCriteria

Required*

string

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

pathMatcher.[].routeRules.[].matchRules.[].prefixMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].queryParameterMatches

Optional

list (object)

pathMatcher.[].routeRules.[].matchRules.[].queryParameterMatches.[]

Optional

object

pathMatcher.[].routeRules.[].matchRules.[].queryParameterMatches.[].exactMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].queryParameterMatches.[].name

Required*

string

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

pathMatcher.[].routeRules.[].matchRules.[].queryParameterMatches.[].presentMatch

Optional

boolean

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

pathMatcher.[].routeRules.[].matchRules.[].queryParameterMatches.[].regexMatch

Optional

string

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

pathMatcher.[].routeRules.[].matchRules.[].regexMatch

Optional

string

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

pathMatcher.[].routeRules.[].priority

Required*

integer

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

pathMatcher.[].routeRules.[].routeAction

Optional

object

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set.

pathMatcher.[].routeRules.[].routeAction.corsPolicy

Optional

object

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

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowCredentials

Optional

boolean

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

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowHeaders

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowHeaders.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowMethods

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowMethods.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowOriginRegexes

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowOriginRegexes.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowOrigins

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.corsPolicy.allowOrigins.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.corsPolicy.disabled

Optional

boolean

If true, specifies the CORS policy is disabled. which indicates that the CORS policy is in effect. Defaults to false.

pathMatcher.[].routeRules.[].routeAction.corsPolicy.exposeHeaders

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.corsPolicy.exposeHeaders.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.corsPolicy.maxAge

Optional

integer

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

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy

Optional

object

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.

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.abort

Optional

object

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

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.abort.httpStatus

Optional

integer

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

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.abort.percentage

Optional

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.

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.delay

Optional

object

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

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.delay.fixedDelay

Optional

object

Specifies the value of the fixed delay interval.

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.delay.fixedDelay.nanos

Optional

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.

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.delay.fixedDelay.seconds

Required*

string

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

pathMatcher.[].routeRules.[].routeAction.faultInjectionPolicy.delay.percentage

Optional

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.

pathMatcher.[].routeRules.[].routeAction.requestMirrorPolicy

Optional

object

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.

pathMatcher.[].routeRules.[].routeAction.requestMirrorPolicy.backendService

Required*

string

The BackendService resource being mirrored to.

pathMatcher.[].routeRules.[].routeAction.retryPolicy

Optional

object

Specifies the retry policy associated with this route.

pathMatcher.[].routeRules.[].routeAction.retryPolicy.numRetries

Required*

integer

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

pathMatcher.[].routeRules.[].routeAction.retryPolicy.perTryTimeout

Optional

object

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.

pathMatcher.[].routeRules.[].routeAction.retryPolicy.perTryTimeout.nanos

Optional

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.

pathMatcher.[].routeRules.[].routeAction.retryPolicy.perTryTimeout.seconds

Required*

string

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

pathMatcher.[].routeRules.[].routeAction.retryPolicy.retryConditions

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.retryPolicy.retryConditions.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.timeout

Optional

object

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.

pathMatcher.[].routeRules.[].routeAction.timeout.nanos

Optional

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.

pathMatcher.[].routeRules.[].routeAction.timeout.seconds

Required*

string

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

pathMatcher.[].routeRules.[].routeAction.urlRewrite

Optional

object

The spec to modify the URL of the request, prior to forwarding the request to the matched service

pathMatcher.[].routeRules.[].routeAction.urlRewrite.hostRewrite

Optional

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.

pathMatcher.[].routeRules.[].routeAction.urlRewrite.pathPrefixRewrite

Optional

string

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

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices

Optional

list (object)

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[]

Optional

object

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].backendServiceRef

Required*

object

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

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].backendServiceRef.external

Optional

string

The selfLink of a ComputeBackendService.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].backendServiceRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].backendServiceRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction

Optional

object

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.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd

Optional

list (object)

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[]

Optional

object

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToRemove

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.requestHeadersToRemove.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd

Optional

list (object)

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[]

Optional

object

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[].headerName

Required*

string

The name of the header.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[].headerValue

Required*

string

The value of the header to add.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToAdd.[].replace

Required*

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.

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToRemove

Optional

list (string)

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].headerAction.responseHeadersToRemove.[]

Optional

string

pathMatcher.[].routeRules.[].routeAction.weightedBackendServices.[].weight

Required*

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

pathMatcher.[].routeRules.[].service

Optional

string

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

pathMatcher.[].routeRules.[].urlRedirect

Optional

object

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set.

pathMatcher.[].routeRules.[].urlRedirect.hostRedirect

Optional

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.

pathMatcher.[].routeRules.[].urlRedirect.httpsRedirect

Optional

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. Defaults to false.

pathMatcher.[].routeRules.[].urlRedirect.pathRedirect

Optional

string

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

pathMatcher.[].routeRules.[].urlRedirect.prefixRedirect

Optional

string

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

pathMatcher.[].routeRules.[].urlRedirect.redirectResponseCode

Optional

string

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

pathMatcher.[].routeRules.[].urlRedirect.stripQuery

Optional

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. Defaults to false.

test

Optional

list (object)

test.[]

Optional

object

test.[].description

Optional

string

Description of this test case.

test.[].host

Required*

string

Host portion of the URL.

test.[].path

Required*

string

Path portion of the URL.

test.[].service

Required*

object

The backend service or backend bucket link that should be matched by this test.

test.[].service.backendBucketRef

Optional

object

test.[].service.backendBucketRef.external

Optional

string

The selfLink of a ComputeBackendBucket.

test.[].service.backendBucketRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

test.[].service.backendBucketRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

test.[].service.backendServiceRef

Optional

object

test.[].service.backendServiceRef.external

Optional

string

The selfLink of a ComputeBackendService.

test.[].service.backendServiceRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

test.[].service.backendServiceRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTimestamp: string
fingerprint: string
mapId: integer
selfLink: string
Fields
conditions

list (object)

conditions.[]

object

conditions.[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions.[].message

string

Human-readable message indicating details about last transition.

conditions.[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions.[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions.[].type

string

Type is the type of the condition.

creationTimestamp

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.

mapId

integer

The unique identifier for the resource.

selfLink

string

Sample YAML(s)

Typical Use Case

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeURLMap
metadata:
  name: computeurlmap-sample
spec:
  location: global
  defaultService:
    backendServiceRef:
      name: computeurlmap-dep1
  pathMatcher:
    - name: allpaths
      defaultService:
        backendServiceRef:
          name: computeurlmap-dep2
      pathRule:
        - paths: ["/home"]
          service:
            backendServiceRef:
              name: computeurlmap-dep3
        - paths: ["/foo"]
          service:
            backendBucketRef:
              name: computeurlmap-dep
  hostRule:
    - hosts: ["example.com"]
      pathMatcher: allpaths
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendBucket
metadata:
  name: computeurlmap-dep
spec:
  bucketRef:
    name: ${PROJECT_ID?}-computeurl-dep
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendService
metadata:
  name: computeurlmap-dep1
spec:
  healthChecks:
    - healthCheckRef:
        name: computeurlmap-dep
  location: global
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendService
metadata:
  name: computeurlmap-dep2
spec:
  healthChecks:
    - healthCheckRef:
        name: computeurlmap-dep
  location: global
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeBackendService
metadata:
  name: computeurlmap-dep3
spec:
  healthChecks:
    - healthCheckRef:
        name: computeurlmap-dep
  location: global
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeHealthCheck
metadata:
  name: computeurlmap-dep
spec:
  checkIntervalSec: 10
  httpHealthCheck:
    port: 80
  location: global
---
apiVersion: storage.cnrm.cloud.google.com/v1beta1
kind: StorageBucket
metadata:
  # StorageBucket names must be globally unique. Replace ${PROJECT_ID?} with your project ID.
  name: ${PROJECT_ID?}-computeurl-dep