@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
325 lines (324 loc) • 12 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Represents a RegionTargetHttpProxy resource, which is used by one or more
* forwarding rules to route incoming HTTP requests to a URL map.
*
* To get more information about RegionTargetHttpProxy, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionTargetHttpProxies)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/compute/docs/load-balancing/http/target-proxies)
*
* ## Example Usage
*
* ### Region Target Http Proxy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* region: "us-central1",
* name: "http-health-check",
* httpHealthCheck: {
* port: 80,
* },
* });
* const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "backend-service",
* protocol: "HTTP",
* timeoutSec: 10,
* loadBalancingScheme: "INTERNAL_MANAGED",
* healthChecks: defaultRegionHealthCheck.id,
* });
* const defaultRegionUrlMap = new gcp.compute.RegionUrlMap("default", {
* region: "us-central1",
* name: "url-map",
* defaultService: defaultRegionBackendService.id,
* hostRules: [{
* hosts: ["mysite.com"],
* pathMatcher: "allpaths",
* }],
* pathMatchers: [{
* name: "allpaths",
* defaultService: defaultRegionBackendService.id,
* pathRules: [{
* paths: ["/*"],
* service: defaultRegionBackendService.id,
* }],
* }],
* });
* const _default = new gcp.compute.RegionTargetHttpProxy("default", {
* region: "us-central1",
* name: "test-proxy",
* urlMap: defaultRegionUrlMap.id,
* });
* ```
* ### Region Target Http Proxy Http Keep Alive Timeout
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* region: "us-central1",
* name: "http-health-check",
* httpHealthCheck: {
* port: 80,
* },
* });
* const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "backend-service",
* portName: "http",
* protocol: "HTTP",
* timeoutSec: 10,
* loadBalancingScheme: "INTERNAL_MANAGED",
* healthChecks: defaultRegionHealthCheck.id,
* });
* const defaultRegionUrlMap = new gcp.compute.RegionUrlMap("default", {
* region: "us-central1",
* name: "url-map",
* defaultService: defaultRegionBackendService.id,
* hostRules: [{
* hosts: ["mysite.com"],
* pathMatcher: "allpaths",
* }],
* pathMatchers: [{
* name: "allpaths",
* defaultService: defaultRegionBackendService.id,
* pathRules: [{
* paths: ["/*"],
* service: defaultRegionBackendService.id,
* }],
* }],
* });
* const _default = new gcp.compute.RegionTargetHttpProxy("default", {
* region: "us-central1",
* name: "test-http-keep-alive-timeout-proxy",
* httpKeepAliveTimeoutSec: 600,
* urlMap: defaultRegionUrlMap.id,
* });
* ```
* ### Region Target Http Proxy Https Redirect
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionUrlMap = new gcp.compute.RegionUrlMap("default", {
* region: "us-central1",
* name: "url-map",
* defaultUrlRedirect: {
* httpsRedirect: true,
* stripQuery: false,
* },
* });
* const _default = new gcp.compute.RegionTargetHttpProxy("default", {
* region: "us-central1",
* name: "test-https-redirect-proxy",
* urlMap: defaultRegionUrlMap.id,
* });
* ```
*
* ## Import
*
* RegionTargetHttpProxy can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/targetHttpProxies/{{name}}`
*
* * `{{project}}/{{region}}/{{name}}`
*
* * `{{region}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, RegionTargetHttpProxy can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/regionTargetHttpProxy:RegionTargetHttpProxy default projects/{{project}}/regions/{{region}}/targetHttpProxies/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/regionTargetHttpProxy:RegionTargetHttpProxy default {{project}}/{{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/regionTargetHttpProxy:RegionTargetHttpProxy default {{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/regionTargetHttpProxy:RegionTargetHttpProxy default {{name}}
* ```
*/
export declare class RegionTargetHttpProxy extends pulumi.CustomResource {
/**
* Get an existing RegionTargetHttpProxy 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<pulumi.ID>, state?: RegionTargetHttpProxyState, opts?: pulumi.CustomResourceOptions): RegionTargetHttpProxy;
/**
* Returns true if the given object is an instance of RegionTargetHttpProxy. 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 RegionTargetHttpProxy;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Specifies how long to keep a connection open, after completing a response,
* while there is no matching traffic (in seconds). If an HTTP keepalive is
* not specified, a default value (600 seconds) will be used. For Regional
* HTTP(S) load balancer, the minimum allowed value is 5 seconds and the
* maximum allowed value is 600 seconds.
*/
readonly httpKeepAliveTimeoutSec: pulumi.Output<number | undefined>;
/**
* 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<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The unique identifier for the resource.
*/
readonly proxyId: pulumi.Output<number>;
/**
* The Region in which the created target https proxy should reside.
* If it is not provided, the provider region is used.
*/
readonly region: pulumi.Output<string>;
/**
* The URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* A reference to the RegionUrlMap resource that defines the mapping from URL
* to the BackendService.
*/
readonly urlMap: pulumi.Output<string>;
/**
* Create a RegionTargetHttpProxy 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: RegionTargetHttpProxyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RegionTargetHttpProxy resources.
*/
export interface RegionTargetHttpProxyState {
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* Specifies how long to keep a connection open, after completing a response,
* while there is no matching traffic (in seconds). If an HTTP keepalive is
* not specified, a default value (600 seconds) will be used. For Regional
* HTTP(S) load balancer, the minimum allowed value is 5 seconds and the
* maximum allowed value is 600 seconds.
*/
httpKeepAliveTimeoutSec?: pulumi.Input<number>;
/**
* 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<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The unique identifier for the resource.
*/
proxyId?: pulumi.Input<number>;
/**
* The Region in which the created target https proxy should reside.
* If it is not provided, the provider region is used.
*/
region?: pulumi.Input<string>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string>;
/**
* A reference to the RegionUrlMap resource that defines the mapping from URL
* to the BackendService.
*/
urlMap?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RegionTargetHttpProxy resource.
*/
export interface RegionTargetHttpProxyArgs {
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* Specifies how long to keep a connection open, after completing a response,
* while there is no matching traffic (in seconds). If an HTTP keepalive is
* not specified, a default value (600 seconds) will be used. For Regional
* HTTP(S) load balancer, the minimum allowed value is 5 seconds and the
* maximum allowed value is 600 seconds.
*/
httpKeepAliveTimeoutSec?: pulumi.Input<number>;
/**
* 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<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The Region in which the created target https proxy should reside.
* If it is not provided, the provider region is used.
*/
region?: pulumi.Input<string>;
/**
* A reference to the RegionUrlMap resource that defines the mapping from URL
* to the BackendService.
*/
urlMap: pulumi.Input<string>;
}