cdktf-crd
Version:
583 lines • 123 kB
TypeScript
import { Manifest, type ManifestConfig } from "@cdktf/provider-kubernetes/lib/manifest";
import { Construct } from "constructs";
export declare class KubernetesComputeURLMapV1beta1Manifest extends Manifest {
constructor(scope: Construct, id: string, config: KubernetesComputeURLMapV1beta1ManifestConfig);
}
export interface KubernetesComputeURLMapV1beta1ManifestConfig extends ManifestConfig {
manifest: {
apiVersion?: "compute.cnrm.cloud.google.com/v1beta1";
kind?: "ComputeURLMap";
metadata: {
annotations?: {
[key: string]: string;
};
labels?: {
[key: string]: string;
};
name: string;
namespace?: string;
};
spec: {
/** @description 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. */
defaultRouteAction?: {
/** @description The specification for allowing client side cross-origin requests. Please see
* [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/). */
corsPolicy?: {
/** @description In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header.
* Default is false. */
allowCredentials?: boolean;
/** @description Specifies the content for the Access-Control-Allow-Headers header. */
allowHeaders?: string[];
/** @description Specifies the content for the Access-Control-Allow-Methods header. */
allowMethods?: string[];
/** @description Specifies the regualar expression patterns that match allowed origins. For regular expression grammar
* please see en.cppreference.com/w/cpp/regex/ecmascript
* An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. */
allowOriginRegexes?: string[];
/** @description 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. */
allowOrigins?: string[];
/** @description If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. */
disabled?: boolean;
/** @description Specifies the content for the Access-Control-Expose-Headers header. */
exposeHeaders?: string[];
/** @description Specifies how long results of a preflight request can be cached in seconds.
* This translates to the Access-Control-Max-Age header. */
maxAge?: number;
};
/** @description 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 a load balancer on a percentage of requests before sending those requests to the backend service.
* Similarly requests from clients can be aborted by the load balancer for a percentage of requests.
* timeout and retryPolicy is ignored by clients that are configured with a faultInjectionPolicy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection.
* Fault injection is not supported with the global external HTTP(S) load balancer (classic). To see which load balancers support fault injection, see Load balancing: [Routing and traffic management features](https://cloud.google.com/load-balancing/docs/features#routing-traffic-management). */
faultInjectionPolicy?: {
/** @description The specification for how client requests are aborted as part of fault injection. */
abort?: {
/** @description The HTTP status code used to abort the request.
* The value must be between 200 and 599 inclusive. */
httpStatus?: number;
/** @description 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. */
percentage?: number;
};
/** @description The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. */
delay?: {
/** @description Specifies the value of the fixed delay interval. */
fixedDelay?: {
/** @description 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. */
nanos?: number;
/** @description 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. */
seconds?: string;
};
/** @description 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. */
percentage?: number;
};
};
/** @description Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service.
* The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow.
* Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. */
requestMirrorPolicy?: {
/** @description The backend service resource being mirrored to.
* The backend service configured for a mirroring policy must reference
* backends that are of the same type as the original backend service
* matched in the URL map.
* Serverless NEG backends are not currently supported as a mirrored
* backend service. */
backendServiceRef?: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendService` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
};
/** @description Specifies the retry policy associated with this route. */
retryPolicy?: {
/** @description Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. */
numRetries?: number;
/** @description 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. */
perTryTimeout?: {
/** @description 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. */
nanos?: number;
/** @description 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. */
seconds?: string;
};
/** @description Specifies one or more conditions when this retry policy applies.
* Valid values are listed below. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true: cancelled, deadline-exceeded, internal, resource-exhausted, unavailable.
* - 5xx : retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For 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 : a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts.
* - retriable-4xx : a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409.
* - refused-stream : a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
* - cancelled : a retry is attempted if the gRPC status code in the response header is set to cancelled.
* - deadline-exceeded : a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded.
* - internal : a retry is attempted if the gRPC status code in the response header is set to internal.
* - resource-exhausted : a retry is attempted if the gRPC status code in the response header is set to resource-exhausted.
* - unavailable : a retry is attempted if the gRPC status code in the response header is set to unavailable. */
retryConditions?: string[];
};
/** @description Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries.
* If not specified, this field uses the largest timeout among all backend services associated with the route.
* Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. */
timeout?: {
/** @description 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. */
nanos?: number;
/** @description 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. */
seconds?: string;
};
/** @description The spec to modify the URL of the request, before forwarding the request to the matched service.
* urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.
* Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. */
urlRewrite?: {
/** @description Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
* The value must be from 1 to 255 characters. */
hostRewrite?: string;
/** @description Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
* The value must be from 1 to 1024 characters. */
pathPrefixRewrite?: string;
};
/** @description 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-zero number.
* After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. */
weightedBackendServices?: {
/** @description The default backend service resource.
* Before forwarding the request to backendService, the loadbalancer
* applies any relevant headerActions specified as part of this
* backendServiceWeight. */
backendServiceRef?: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendService` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
/** @description 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.
* 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. */
headerAction?: {
/** @description Headers to add to a matching request before forwarding the request to the backendService. */
requestHeadersToAdd?: {
/** @description The name of the header. */
headerName?: string;
/** @description The value of the header to add. */
headerValue?: string;
/** @description 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.
* The default value is false. */
replace?: boolean;
}[];
/** @description A list of header names for headers that need to be removed from the request before forwarding the request to the backendService. */
requestHeadersToRemove?: string[];
/** @description Headers to add the response before sending the response back to the client. */
responseHeadersToAdd?: {
/** @description The name of the header. */
headerName?: string;
/** @description The value of the header to add. */
headerValue?: string;
/** @description 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.
* The default value is false. */
replace?: boolean;
}[];
/** @description A list of header names for headers that need to be removed from the response before sending the response back to the client. */
responseHeadersToRemove?: string[];
};
/** @description Specifies the fraction of traffic sent to a backend service, 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 backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy.
* The value must be from 0 to 1000. */
weight?: number;
}[];
};
/** @description The defaultService resource to which traffic is directed if none of
* the hostRules match.
* For the Global URL Map, it should be a reference to the backend
* service or backend bucket.
* For the Regional URL Map, it should be a reference to the backend
* service.
* If defaultRouteAction is additionally specified, advanced routing
* actions like URL Rewrites, etc. take effect prior to 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?: {
backendBucketRef?: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendBucket` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
backendServiceRef?: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendService` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
} & (unknown | unknown);
/** @description 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?: {
/** @description 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. */
hostRedirect?: string;
/** @description 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. */
httpsRedirect?: boolean;
/** @description 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. */
pathRedirect?: string;
/** @description 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. */
prefixRedirect?: string;
/** @description 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"]. */
redirectResponseCode?: string;
/** @description 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. */
stripQuery: boolean;
};
/** @description An optional description of this resource. Provide this property when
* you create the resource. */
description?: string;
/** @description 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?: {
/** @description Headers to add to a matching request prior to forwarding the request to the
* backendService. */
requestHeadersToAdd?: {
/** @description The name of the header. */
headerName: string;
/** @description The value of the header to add. */
headerValue: string;
/** @description 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. */
replace: boolean;
}[];
/** @description A list of header names for headers that need to be removed from the request
* prior to forwarding the request to the backendService. */
requestHeadersToRemove?: string[];
/** @description Headers to add the response prior to sending the response back to the client. */
responseHeadersToAdd?: {
/** @description The name of the header. */
headerName: string;
/** @description The value of the header to add. */
headerValue: string;
/** @description 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. */
replace: boolean;
}[];
/** @description A list of header names for headers that need to be removed from the response
* prior to sending the response back to the client. */
responseHeadersToRemove?: string[];
};
/** @description The list of HostRules to use against the URL. */
hostRule?: {
/** @description An optional description of this HostRule. Provide this property
* when you create the resource. */
description?: string;
/** @description 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 .. */
hosts: string[];
/** @description The name of the PathMatcher to use to match the path portion of
* the URL if the hostRule matches the URL's host portion. */
pathMatcher: string;
}[];
/** @description Location represents the geographical location of the ComputeURLMap. Specify a region name or "global" for global resources. Reference: GCP definition of regions/zones (https://cloud.google.com/compute/docs/regions-zones/) */
location: string;
/** @description The list of named PathMatchers to use against the URL. */
pathMatcher?: {
/** @description 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. */
defaultRouteAction?: {
/** @description The specification for allowing client side cross-origin requests. Please see
* [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/). */
corsPolicy?: {
/** @description 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. */
allowCredentials?: boolean;
/** @description Specifies the content for the Access-Control-Allow-Headers header. */
allowHeaders?: string[];
/** @description Specifies the content for the Access-Control-Allow-Methods header. */
allowMethods?: string[];
/** @description 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. */
allowOriginRegexes?: string[];
/** @description 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. */
allowOrigins?: string[];
/** @description If true, specifies the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect. */
disabled?: boolean;
/** @description Specifies the content for the Access-Control-Expose-Headers header. */
exposeHeaders?: string[];
/** @description Specifies how long results of a preflight request can be cached in seconds.
* This translates to the Access-Control-Max-Age header. */
maxAge?: number;
};
/** @description 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. */
faultInjectionPolicy?: {
/** @description The specification for how client requests are aborted as part of fault injection. */
abort?: {
/** @description The HTTP status code used to abort the request.
* The value must be between 200 and 599 inclusive. */
httpStatus?: number;
/** @description 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. */
percentage?: number;
};
/** @description The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. */
delay?: {
/** @description Specifies the value of the fixed delay interval. */
fixedDelay?: {
/** @description 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. */
nanos?: number;
/** @description 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. */
seconds?: string;
};
/** @description 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. */
percentage?: number;
};
};
/** @description 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. */
requestMirrorPolicy?: {
/** @description Required. The backend service resource being mirrored to. */
backendServiceRef: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendService` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
};
/** @description Specifies the retry policy associated with this route. */
retryPolicy?: {
/** @description Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. */
numRetries?: number;
/** @description 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. */
perTryTimeout?: {
/** @description 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. */
nanos?: number;
/** @description 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. */
seconds?: string;
};
/** @description 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. */
retryConditions?: string[];
};
/** @description 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. */
timeout?: {
/** @description 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. */
nanos?: number;
/** @description 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. */
seconds?: string;
};
/** @description The spec to modify the URL of the request, prior to forwarding the request to the matched service. */
urlRewrite?: {
/** @description 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. */
hostRewrite?: string;
/** @description 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. */
pathPrefixRewrite?: string;
};
/** @description 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. */
weightedBackendServices?: {
/** @description The default backend service resource.
* Before forwarding the request to backendService, the loadbalancer
* applies any relevant headerActions specified as part of this
* backendServiceWeight. */
backendServiceRef?: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendService` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
/** @description 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. */
headerAction?: {
/** @description Headers to add to a matching request prior to forwarding the request to the backendService. */
requestHeadersToAdd?: {
/** @description The name of the header to add. */
headerName?: string;
/** @description The value of the header to add. */
headerValue?: string;
/** @description 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. */
replace?: boolean;
}[];
/** @description A list of header names for headers that need to be removed from the request prior to
* forwarding the request to the backendService. */
requestHeadersToRemove?: string[];
/** @description Headers to add the response prior to sending the response back to the client. */
responseHeadersToAdd?: {
/** @description The name of the header to add. */
headerName?: string;
/** @description The value of the header to add. */
headerValue?: string;
/** @description 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. */
replace?: boolean;
}[];
/** @description A list of header names for headers that need to be removed from the response prior to sending the
* response back to the client. */
responseHeadersToRemove?: string[];
};
/** @description 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. */
weight?: number;
}[];
};
/** @description The default service to use if none of the pathRules defined by this
* PathMatcher is matched by the URL's path portion.
* For the Global URL Map, it should be a reference to the backend
* service or backend bucket.
* For the Regional URL Map, it should be a reference to the backend
* service. */
defaultService?: {
backendBucketRef?: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendBucket` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
backendServiceRef?: {
/** @description Allowed value: The `selfLink` field of a `ComputeBackendService` resource. */
external?: string;
/** @description Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */
name?: string;
/** @description Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */
namespace?: string;
} & (unknown | unknown);
} & (unknown | unknown);
/** @description 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?: {
/** @description 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. */
hostRedirect?: string;
/** @description 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. */
httpsRedirect?: boolean;
/** @description 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. */
pathRedirect?: string;
/** @description 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. */
prefixRedirect?: string;
/** @description The