@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; /** * Represents a TargetHttpProxy resource, which is used by one or more global * forwarding rule to route incoming HTTP requests to a URL map. * * To get more information about TargetHttpProxy, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/v1/targetHttpProxies) * * How-to Guides * * [Official Documentation](https://cloud.google.com/compute/docs/load-balancing/http/target-proxies) * * ## Example Usage * * ### Target Http Proxy Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const defaultHttpHealthCheck = new gcp.compute.HttpHealthCheck("default", { * name: "http-health-check", * requestPath: "/", * checkIntervalSec: 1, * timeoutSec: 1, * }); * const defaultBackendService = new gcp.compute.BackendService("default", { * name: "backend-service", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * healthChecks: defaultHttpHealthCheck.id, * }); * const defaultURLMap = new gcp.compute.URLMap("default", { * name: "url-map", * defaultService: defaultBackendService.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: defaultBackendService.id, * pathRules: [{ * paths: ["/*"], * service: defaultBackendService.id, * }], * }], * }); * const _default = new gcp.compute.TargetHttpProxy("default", { * name: "test-proxy", * urlMap: defaultURLMap.id, * }); * ``` * ### Target Http Proxy Http Keep Alive Timeout * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const defaultHttpHealthCheck = new gcp.compute.HttpHealthCheck("default", { * name: "http-health-check", * requestPath: "/", * checkIntervalSec: 1, * timeoutSec: 1, * }); * const defaultBackendService = new gcp.compute.BackendService("default", { * name: "backend-service", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * loadBalancingScheme: "EXTERNAL_MANAGED", * healthChecks: defaultHttpHealthCheck.id, * }); * const defaultURLMap = new gcp.compute.URLMap("default", { * name: "url-map", * defaultService: defaultBackendService.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: defaultBackendService.id, * pathRules: [{ * paths: ["/*"], * service: defaultBackendService.id, * }], * }], * }); * const _default = new gcp.compute.TargetHttpProxy("default", { * name: "test-http-keep-alive-timeout-proxy", * httpKeepAliveTimeoutSec: 610, * urlMap: defaultURLMap.id, * }); * ``` * ### Target Http Proxy Https Redirect * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const defaultURLMap = new gcp.compute.URLMap("default", { * name: "url-map", * defaultUrlRedirect: { * httpsRedirect: true, * stripQuery: false, * }, * }); * const _default = new gcp.compute.TargetHttpProxy("default", { * name: "test-https-redirect-proxy", * urlMap: defaultURLMap.id, * }); * ``` * ### Target Http Proxy Fingerprint * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const defaultHttpHealthCheck = new gcp.compute.HttpHealthCheck("default", { * name: "http-health-check", * requestPath: "/", * checkIntervalSec: 1, * timeoutSec: 1, * }); * const defaultBackendService = new gcp.compute.BackendService("default", { * name: "backend-service", * portName: "http", * protocol: "HTTP", * timeoutSec: 10, * healthChecks: defaultHttpHealthCheck.id, * }); * const defaultURLMap = new gcp.compute.URLMap("default", { * name: "url-map", * defaultService: defaultBackendService.id, * hostRules: [{ * hosts: ["mysite.com"], * pathMatcher: "allpaths", * }], * pathMatchers: [{ * name: "allpaths", * defaultService: defaultBackendService.id, * pathRules: [{ * paths: ["/*"], * service: defaultBackendService.id, * }], * }], * }); * const _default = new gcp.compute.TargetHttpProxy("default", { * name: "test-fingerprint-proxy", * urlMap: defaultURLMap.id, * }); * export const targetHttpProxyFingerprint = _default.fingerprint; * ``` * * ## Import * * TargetHttpProxy can be imported using any of these accepted formats: * * * `projects/{{project}}/global/targetHttpProxies/{{name}}` * * * `{{project}}/{{name}}` * * * `{{name}}` * * When using the `pulumi import` command, TargetHttpProxy can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/targetHttpProxy:TargetHttpProxy default projects/{{project}}/global/targetHttpProxies/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/targetHttpProxy:TargetHttpProxy default {{project}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/targetHttpProxy:TargetHttpProxy default {{name}} * ``` */ export declare class TargetHttpProxy extends pulumi.CustomResource { /** * Get an existing TargetHttpProxy 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?: TargetHttpProxyState, opts?: pulumi.CustomResourceOptions): TargetHttpProxy; /** * Returns true if the given object is an instance of TargetHttpProxy. 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 TargetHttpProxy; /** * Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output<string>; /** * An optional description of this resource. */ readonly description: pulumi.Output<string | undefined>; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. * This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to * patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. * To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. * A base64-encoded string. */ readonly fingerprint: pulumi.Output<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 will be used. For Global * external HTTP(S) load balancer, the default value is 610 seconds, the * minimum allowed value is 5 seconds and the maximum allowed value is 1200 * seconds. For cross-region internal HTTP(S) load balancer, the default * value is 600 seconds, the minimum allowed value is 5 seconds, and the * maximum allowed value is 600 seconds. For Global external HTTP(S) load * balancer (classic), this option is not available publicly. */ 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>; /** * This field only applies when the forwarding rule that references * this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ readonly proxyBind: pulumi.Output<boolean>; /** * The unique identifier for the resource. */ readonly proxyId: pulumi.Output<number>; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output<string>; /** * A reference to the UrlMap resource that defines the mapping from URL * to the BackendService. */ readonly urlMap: pulumi.Output<string>; /** * Create a TargetHttpProxy 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: TargetHttpProxyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering TargetHttpProxy resources. */ export interface TargetHttpProxyState { /** * Creation timestamp in RFC3339 text format. */ creationTimestamp?: pulumi.Input<string>; /** * An optional description of this resource. */ description?: pulumi.Input<string>; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. * This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to * patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. * To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. * A base64-encoded string. */ fingerprint?: 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 will be used. For Global * external HTTP(S) load balancer, the default value is 610 seconds, the * minimum allowed value is 5 seconds and the maximum allowed value is 1200 * seconds. For cross-region internal HTTP(S) load balancer, the default * value is 600 seconds, the minimum allowed value is 5 seconds, and the * maximum allowed value is 600 seconds. For Global external HTTP(S) load * balancer (classic), this option is not available publicly. */ 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>; /** * This field only applies when the forwarding rule that references * this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ proxyBind?: pulumi.Input<boolean>; /** * The unique identifier for the resource. */ proxyId?: pulumi.Input<number>; /** * The URI of the created resource. */ selfLink?: pulumi.Input<string>; /** * A reference to the UrlMap resource that defines the mapping from URL * to the BackendService. */ urlMap?: pulumi.Input<string>; } /** * The set of arguments for constructing a TargetHttpProxy resource. */ export interface TargetHttpProxyArgs { /** * 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 will be used. For Global * external HTTP(S) load balancer, the default value is 610 seconds, the * minimum allowed value is 5 seconds and the maximum allowed value is 1200 * seconds. For cross-region internal HTTP(S) load balancer, the default * value is 600 seconds, the minimum allowed value is 5 seconds, and the * maximum allowed value is 600 seconds. For Global external HTTP(S) load * balancer (classic), this option is not available publicly. */ 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>; /** * This field only applies when the forwarding rule that references * this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ proxyBind?: pulumi.Input<boolean>; /** * A reference to the UrlMap resource that defines the mapping from URL * to the BackendService. */ urlMap: pulumi.Input<string>; }