import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * UrlMaps are used to route requests to a backend service based on rules * that you define for the host and path of an incoming URL. * * ## Example Usage * * ### Region Url Map Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * checkIntervalSec: 1, * timeoutSec: 1, * httpHealthCheck: { * port: 80, * requestPath: "/", * }, * }); * const login = new gcp.compute.RegionBackendService("login", { * region: "us-central1", * name: "login", * protocol: "HTTP", * loadBalancingScheme: "INTERNAL_MANAGED", * timeoutSec: 10, * healthChecks: _default.id, * }); * const home = new gcp.compute.RegionBackendService("home", { * region: "us-central1", * name: "home", * protocol: "HTTP", * loadBalancingScheme: "INTERNAL_MANAGED", * timeoutSec: 10, * healthChecks: _default.id, * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * region: "us-central1", * name: "regionurlmap", * description: "a description", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * pathRules: [ * { * paths: ["/home"], * service: home.id, * }, * { * paths: ["/login"], * service: login.id, * }, * ], * }], * tests: [{ * service: home.id, * host: "hi.com", * path: "/home", * }], * }); * ``` * ### Region Url Map Default Route Action * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * checkIntervalSec: 1, * timeoutSec: 1, * httpHealthCheck: { * port: 80, * requestPath: "/", * }, * }); * const login = new gcp.compute.RegionBackendService("login", { * region: "us-central1", * name: "login", * protocol: "HTTP", * loadBalancingScheme: "INTERNAL_MANAGED", * timeoutSec: 10, * healthChecks: _default.id, * }); * const home = new gcp.compute.RegionBackendService("home", { * region: "us-central1", * name: "home", * protocol: "HTTP", * loadBalancingScheme: "INTERNAL_MANAGED", * timeoutSec: 10, * healthChecks: _default.id, * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * region: "us-central1", * name: "regionurlmap", * description: "a description", * defaultRouteAction: { * retryPolicy: { * retryConditions: [ * "5xx", * "gateway-error", * ], * numRetries: 3, * perTryTimeout: { * seconds: "0", * nanos: 500, * }, * }, * requestMirrorPolicy: { * backendService: home.id, * }, * weightedBackendServices: [ * { * backendService: login.id, * weight: 200, * headerAction: { * requestHeadersToAdds: [{ * headerName: "foo-request-1", * headerValue: "bar", * replace: true, * }], * requestHeadersToRemoves: ["fizz"], * responseHeadersToAdds: [{ * headerName: "foo-response-1", * headerValue: "bar", * replace: true, * }], * responseHeadersToRemoves: ["buzz"], * }, * }, * { * backendService: home.id, * weight: 100, * headerAction: { * requestHeadersToAdds: [ * { * headerName: "foo-request-1", * headerValue: "bar", * replace: true, * }, * { * headerName: "foo-request-2", * headerValue: "bar", * replace: true, * }, * ], * requestHeadersToRemoves: ["fizz"], * responseHeadersToAdds: [ * { * headerName: "foo-response-2", * headerValue: "bar", * replace: true, * }, * { * headerName: "foo-response-1", * headerValue: "bar", * replace: true, * }, * ], * responseHeadersToRemoves: ["buzz"], * }, * }, * ], * urlRewrite: { * hostRewrite: "dev.example.com", * pathPrefixRewrite: "/v1/api/", * }, * corsPolicy: { * disabled: false, * allowCredentials: true, * allowHeaders: ["foobar"], * allowMethods: [ * "GET", * "POST", * ], * allowOrigins: ["example.com"], * exposeHeaders: ["foobar"], * maxAge: 60, * }, * faultInjectionPolicy: { * delay: { * fixedDelay: { * seconds: "0", * nanos: 500, * }, * percentage: 0.5, * }, * abort: { * httpStatus: 500, * percentage: 0.5, * }, * }, * timeout: { * seconds: "0", * nanos: 500, * }, * }, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * pathRules: [ * { * paths: ["/home"], * service: home.id, * }, * { * paths: ["/login"], * service: login.id, * }, * ], * }], * tests: [{ * service: home.id, * host: "hi.com", * path: "/home", * }], * }); * ``` * ### Region Url Map L7 Ilb Path * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * name: "home", * protocol: "HTTP", * timeoutSec: 10, * healthChecks: _default.id, * loadBalancingScheme: "INTERNAL_MANAGED", * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * name: "regionurlmap", * description: "a description", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * pathRules: [{ * paths: ["/home"], * routeAction: { * corsPolicy: { * allowCredentials: true, * allowHeaders: ["Allowed content"], * allowMethods: ["GET"], * allowOrigins: ["Allowed origin"], * exposeHeaders: ["Exposed header"], * maxAge: 30, * disabled: false, * }, * faultInjectionPolicy: { * abort: { * httpStatus: 234, * percentage: 5.6, * }, * delay: { * fixedDelay: { * seconds: "0", * nanos: 50000, * }, * percentage: 7.8, * }, * }, * requestMirrorPolicy: { * backendService: home.id, * }, * retryPolicy: { * numRetries: 4, * perTryTimeout: { * seconds: "30", * }, * retryConditions: [ * "5xx", * "deadline-exceeded", * ], * }, * timeout: { * seconds: "20", * nanos: 750000000, * }, * urlRewrite: { * hostRewrite: "dev.example.com", * pathPrefixRewrite: "/v1/api/", * }, * weightedBackendServices: [{ * backendService: home.id, * weight: 400, * headerAction: { * requestHeadersToRemoves: ["RemoveMe"], * requestHeadersToAdds: [{ * headerName: "AddMe", * headerValue: "MyValue", * replace: true, * }], * responseHeadersToRemoves: ["RemoveMe"], * responseHeadersToAdds: [{ * headerName: "AddMe", * headerValue: "MyValue", * replace: false, * }], * }, * }], * }, * }], * }], * tests: [{ * service: home.id, * host: "hi.com", * path: "/home", * }], * }); * ``` * ### Region Url Map L7 Ilb Path Partial * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * name: "home", * protocol: "HTTP", * timeoutSec: 10, * healthChecks: _default.id, * loadBalancingScheme: "INTERNAL_MANAGED", * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * name: "regionurlmap", * description: "a description", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * pathRules: [{ * paths: ["/home"], * routeAction: { * retryPolicy: { * numRetries: 4, * perTryTimeout: { * seconds: "30", * }, * retryConditions: [ * "5xx", * "deadline-exceeded", * ], * }, * timeout: { * seconds: "20", * nanos: 750000000, * }, * urlRewrite: { * hostRewrite: "dev.example.com", * pathPrefixRewrite: "/v1/api/", * }, * weightedBackendServices: [{ * backendService: home.id, * weight: 400, * headerAction: { * responseHeadersToAdds: [{ * headerName: "AddMe", * headerValue: "MyValue", * replace: false, * }], * }, * }], * }, * }], * }], * tests: [{ * service: home.id, * host: "hi.com", * path: "/home", * }], * }); * ``` * ### Region Url Map L7 Ilb Route * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * name: "home", * protocol: "HTTP", * timeoutSec: 10, * healthChecks: _default.id, * loadBalancingScheme: "INTERNAL_MANAGED", * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * name: "regionurlmap", * description: "a description", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * routeRules: [{ * priority: 1, * headerAction: { * requestHeadersToRemoves: ["RemoveMe2"], * requestHeadersToAdds: [{ * headerName: "AddSomethingElse", * headerValue: "MyOtherValue", * replace: true, * }], * responseHeadersToRemoves: ["RemoveMe3"], * responseHeadersToAdds: [{ * headerName: "AddMe", * headerValue: "MyValue", * replace: false, * }], * }, * matchRules: [{ * fullPathMatch: "a full path", * headerMatches: [{ * headerName: "someheader", * exactMatch: "match this exactly", * invertMatch: true, * }], * ignoreCase: true, * metadataFilters: [{ * filterMatchCriteria: "MATCH_ANY", * filterLabels: [{ * name: "PLANET", * value: "MARS", * }], * }], * queryParameterMatches: [{ * name: "a query parameter", * presentMatch: true, * }], * }], * urlRedirect: { * hostRedirect: "A host", * httpsRedirect: false, * pathRedirect: "some/path", * redirectResponseCode: "TEMPORARY_REDIRECT", * stripQuery: true, * }, * }], * }], * tests: [{ * service: home.id, * host: "hi.com", * path: "/home", * }], * }); * ``` * ### Region Url Map L7 Ilb Route Partial * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * name: "home", * protocol: "HTTP", * timeoutSec: 10, * healthChecks: _default.id, * loadBalancingScheme: "INTERNAL_MANAGED", * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * name: "regionurlmap", * description: "a description", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * routeRules: [{ * priority: 1, * service: home.id, * headerAction: { * requestHeadersToRemoves: ["RemoveMe2"], * }, * matchRules: [{ * fullPathMatch: "a full path", * headerMatches: [{ * headerName: "someheader", * exactMatch: "match this exactly", * invertMatch: true, * }], * queryParameterMatches: [{ * name: "a query parameter", * presentMatch: true, * }], * }], * }], * }], * tests: [{ * service: home.id, * host: "hi.com", * path: "/home", * }], * }); * ``` * ### Region Url Map Path Template Match * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * checkIntervalSec: 1, * timeoutSec: 1, * httpHealthCheck: { * port: 80, * requestPath: "/", * }, * }); * const home_backend = new gcp.compute.RegionBackendService("home-backend", { * region: "us-central1", * name: "home-service", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "EXTERNAL_MANAGED", * healthChecks: _default.id, * }); * const cart_backend = new gcp.compute.RegionBackendService("cart-backend", { * region: "us-central1", * name: "cart-service", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "EXTERNAL_MANAGED", * healthChecks: _default.id, * }); * const user_backend = new gcp.compute.RegionBackendService("user-backend", { * region: "us-central1", * name: "user-service", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "EXTERNAL_MANAGED", * healthChecks: _default.id, * }); * const urlmap = new gcp.compute.RegionUrlMap("urlmap", { * region: "us-central1", * name: "urlmap", * description: "a description", * defaultService: home_backend.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "mysite", * }], * pathMatchers: [{ * name: "mysite", * defaultService: home_backend.id, * routeRules: [ * { * matchRules: [{ * pathTemplateMatch: "/xyzwebservices/v2/xyz/users/{username=*}/carts/{cartid=**}", * }], * service: cart_backend.id, * priority: 1, * routeAction: { * urlRewrite: { * pathTemplateRewrite: "/{username}-{cartid}/", * }, * }, * }, * { * matchRules: [{ * pathTemplateMatch: "/xyzwebservices/v2/xyz/users/*/accountinfo/*", * }], * service: user_backend.id, * priority: 2, * }, * ], * }], * }); * ``` * ### Region Url Map Path Matcher Default Route Action * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * checkIntervalSec: 1, * timeoutSec: 1, * httpHealthCheck: { * port: 80, * requestPath: "/", * }, * }); * const login = new gcp.compute.RegionBackendService("login", { * region: "us-central1", * name: "login", * protocol: "HTTP", * loadBalancingScheme: "INTERNAL_MANAGED", * timeoutSec: 10, * healthChecks: _default.id, * }); * const home = new gcp.compute.RegionBackendService("home", { * region: "us-central1", * name: "home", * protocol: "HTTP", * loadBalancingScheme: "INTERNAL_MANAGED", * timeoutSec: 10, * healthChecks: _default.id, * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * region: "us-central1", * name: "regionurlmap", * description: "a description", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultRouteAction: { * corsPolicy: { * disabled: false, * allowCredentials: true, * allowHeaders: ["foobar"], * allowMethods: [ * "GET", * "POST", * ], * allowOrigins: ["example.com"], * exposeHeaders: ["foobar"], * maxAge: 60, * }, * faultInjectionPolicy: { * abort: { * httpStatus: 500, * percentage: 0.5, * }, * delay: { * fixedDelay: { * nanos: 500, * seconds: "0", * }, * percentage: 0.5, * }, * }, * requestMirrorPolicy: { * backendService: home.id, * }, * retryPolicy: { * numRetries: 3, * perTryTimeout: { * nanos: 500, * seconds: "0", * }, * retryConditions: [ * "5xx", * "gateway-error", * ], * }, * timeout: { * nanos: 500, * seconds: "0", * }, * urlRewrite: { * hostRewrite: "dev.example.com", * pathPrefixRewrite: "/v1/api/", * }, * weightedBackendServices: [ * { * backendService: home.id, * headerAction: { * requestHeadersToAdds: [ * { * headerName: "foo-request-1", * headerValue: "bar", * replace: true, * }, * { * headerName: "foo-request-2", * headerValue: "bar", * replace: true, * }, * ], * requestHeadersToRemoves: ["fizz"], * responseHeadersToAdds: [ * { * headerName: "foo-response-1", * headerValue: "bar", * replace: true, * }, * { * headerName: "foo-response-2", * headerValue: "bar", * replace: true, * }, * ], * responseHeadersToRemoves: ["buzz"], * }, * weight: 100, * }, * { * backendService: login.id, * headerAction: { * requestHeadersToAdds: [ * { * headerName: "foo-request-1", * headerValue: "bar", * replace: true, * }, * { * headerName: "foo-request-2", * headerValue: "bar", * replace: true, * }, * ], * requestHeadersToRemoves: ["fizz"], * responseHeadersToAdds: [ * { * headerName: "foo-response-1", * headerValue: "bar", * replace: true, * }, * { * headerName: "foo-response-2", * headerValue: "bar", * replace: true, * }, * ], * responseHeadersToRemoves: ["buzz"], * }, * weight: 200, * }, * ], * }, * pathRules: [ * { * paths: ["/home"], * service: home.id, * }, * { * paths: ["/login"], * service: login.id, * }, * ], * }], * tests: [{ * service: home.id, * host: "hi.com", * path: "/home", * }], * }); * ``` * ### Region Url Map Default Mirror Percent * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * region: "us-central1", * name: "home", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const mirror = new gcp.compute.RegionBackendService("mirror", { * region: "us-central1", * name: "mirror", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * region: "us-central1", * name: "regionurlmap", * description: "Test for default route action mirror percent", * defaultService: home.id, * defaultRouteAction: { * requestMirrorPolicy: { * backendService: mirror.id, * mirrorPercent: 50, * }, * }, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * }], * }); * ``` * ### Region Url Map Path Matcher Default Mirror Percent * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * region: "us-central1", * name: "home", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const mirror = new gcp.compute.RegionBackendService("mirror", { * region: "us-central1", * name: "mirror", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * region: "us-central1", * name: "regionurlmap", * description: "Test for default route action mirror percent", * defaultService: home.id, * defaultRouteAction: { * requestMirrorPolicy: { * backendService: mirror.id, * mirrorPercent: 50, * }, * }, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * }], * }); * ``` * ### Region Url Map Path Rule Mirror Percent * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * region: "us-central1", * name: "home", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const mirror = new gcp.compute.RegionBackendService("mirror", { * region: "us-central1", * name: "mirror", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * region: "us-central1", * name: "regionurlmap", * description: "Test for path matcher default route action mirror percent", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * defaultRouteAction: { * requestMirrorPolicy: { * backendService: mirror.id, * mirrorPercent: 75, * }, * }, * }], * }); * ``` * ### Region Url Map Route Rule Mirror Percent * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RegionHealthCheck("default", { * region: "us-central1", * name: "health-check", * httpHealthCheck: { * port: 80, * }, * }); * const home = new gcp.compute.RegionBackendService("home", { * region: "us-central1", * name: "home", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const mirror = new gcp.compute.RegionBackendService("mirror", { * region: "us-central1", * name: "mirror", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "INTERNAL_MANAGED", * healthChecks: _default.id, * }); * const regionurlmap = new gcp.compute.RegionUrlMap("regionurlmap", { * region: "us-central1", * name: "regionurlmap", * description: "Test for path rule route action mirror percent", * defaultService: home.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: home.id, * pathRules: [{ * paths: ["/home"], * service: home.id, * routeAction: { * requestMirrorPolicy: { * backendService: mirror.id, * mirrorPercent: 25, * }, * }, * }], * }], * }); * ``` * * ## Import * * RegionUrlMap can be imported using any of these accepted formats: * * * `projects/{{project}}/regions/{{region}}/urlMaps/{{name}}` * * * `{{project}}/{{region}}/{{name}}` * * * `{{region}}/{{name}}` * * * `{{name}}` * * When using the `pulumi import` command, RegionUrlMap can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/regionUrlMap:RegionUrlMap default projects/{{project}}/regions/{{region}}/urlMaps/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionUrlMap:RegionUrlMap default {{project}}/{{region}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionUrlMap:RegionUrlMap default {{region}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionUrlMap:RegionUrlMap default {{name}} * ``` */ export declare class RegionUrlMap extends pulumi.CustomResource { /** * Get an existing RegionUrlMap resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: RegionUrlMapState, opts?: pulumi.CustomResourceOptions): RegionUrlMap; /** * Returns true if the given object is an instance of RegionUrlMap. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is RegionUrlMap; /** * Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output; /** * 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. * Structure is documented below. */ readonly defaultRouteAction: pulumi.Output; /** * The full or partial URL of the defaultService resource to which traffic is directed if * none of the hostRules match. 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. */ readonly defaultService: pulumi.Output; /** * When none of the specified hostRules match, the request is redirected to a URL specified * by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or * defaultRouteAction must not be set. * Structure is documented below. */ readonly defaultUrlRedirect: pulumi.Output; /** * An optional description of this resource. Provide this property when * you create the resource. */ readonly description: pulumi.Output; /** * Fingerprint of this resource. This field is used internally during * updates of this resource. */ readonly fingerprint: pulumi.Output; /** * 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. * Structure is documented below. */ readonly headerAction: pulumi.Output; /** * The list of HostRules to use against the URL. * Structure is documented below. */ readonly hostRules: pulumi.Output; /** * The unique identifier for the resource. */ readonly mapId: pulumi.Output; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ readonly name: pulumi.Output; /** * The list of named PathMatchers to use against the URL. * Structure is documented below. */ readonly pathMatchers: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The Region in which the url map should reside. * If it is not provided, the provider region is used. */ readonly region: pulumi.Output; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output; /** * The list of expected URL mappings. Requests to update this UrlMap will * succeed only if all of the test cases pass. * Structure is documented below. */ readonly tests: pulumi.Output; /** * Create a RegionUrlMap resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: RegionUrlMapArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RegionUrlMap resources. */ export interface RegionUrlMapState { /** * Creation timestamp in RFC3339 text format. */ creationTimestamp?: pulumi.Input; /** * 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. * Structure is documented below. */ defaultRouteAction?: pulumi.Input; /** * The full or partial URL of the defaultService resource to which traffic is directed if * none of the hostRules match. 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?: pulumi.Input; /** * When none of the specified hostRules match, the request is redirected to a URL specified * by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or * defaultRouteAction must not be set. * Structure is documented below. */ defaultUrlRedirect?: pulumi.Input; /** * An optional description of this resource. Provide this property when * you create the resource. */ description?: pulumi.Input; /** * Fingerprint of this resource. This field is used internally during * updates of this resource. */ fingerprint?: pulumi.Input; /** * 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. * Structure is documented below. */ headerAction?: pulumi.Input; /** * The list of HostRules to use against the URL. * Structure is documented below. */ hostRules?: pulumi.Input[]>; /** * The unique identifier for the resource. */ mapId?: pulumi.Input; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input; /** * The list of named PathMatchers to use against the URL. * Structure is documented below. */ pathMatchers?: pulumi.Input[]>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The Region in which the url map should reside. * If it is not provided, the provider region is used. */ region?: pulumi.Input; /** * The URI of the created resource. */ selfLink?: pulumi.Input; /** * The list of expected URL mappings. Requests to update this UrlMap will * succeed only if all of the test cases pass. * Structure is documented below. */ tests?: pulumi.Input[]>; } /** * The set of arguments for constructing a RegionUrlMap resource. */ export interface RegionUrlMapArgs { /** * 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. * Structure is documented below. */ defaultRouteAction?: pulumi.Input; /** * The full or partial URL of the defaultService resource to which traffic is directed if * none of the hostRules match. 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?: pulumi.Input; /** * When none of the specified hostRules match, the request is redirected to a URL specified * by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or * defaultRouteAction must not be set. * Structure is documented below. */ defaultUrlRedirect?: pulumi.Input; /** * An optional description of this resource. Provide this property when * you create the resource. */ description?: pulumi.Input; /** * 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. * Structure is documented below. */ headerAction?: pulumi.Input; /** * The list of HostRules to use against the URL. * Structure is documented below. */ hostRules?: pulumi.Input[]>; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and match * the regular expression `a-z?` which means the * first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input; /** * The list of named PathMatchers to use against the URL. * Structure is documented below. */ pathMatchers?: pulumi.Input[]>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The Region in which the url map should reside. * If it is not provided, the provider region is used. */ region?: pulumi.Input; /** * The list of expected URL mappings. Requests to update this UrlMap will * succeed only if all of the test cases pass. * Structure is documented below. */ tests?: pulumi.Input[]>; }