@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
238 lines (237 loc) • 8.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Represents a TargetTcpProxy resource, which is used by one or more
* global forwarding rule to route incoming TCP requests to a Backend
* service.
*
* To get more information about TargetTcpProxy, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/v1/targetTcpProxies)
* * How-to Guides
* * [Setting Up TCP proxy for Google Cloud Load Balancing](https://cloud.google.com/compute/docs/load-balancing/tcp-ssl/tcp-proxy)
*
* ## Example Usage
*
* ### Target Tcp Proxy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultHealthCheck = new gcp.compute.HealthCheck("default", {
* name: "health-check",
* timeoutSec: 1,
* checkIntervalSec: 1,
* tcpHealthCheck: {
* port: 443,
* },
* });
* const defaultBackendService = new gcp.compute.BackendService("default", {
* name: "backend-service",
* protocol: "TCP",
* timeoutSec: 10,
* healthChecks: defaultHealthCheck.id,
* });
* const _default = new gcp.compute.TargetTCPProxy("default", {
* name: "test-proxy",
* backendService: defaultBackendService.id,
* });
* ```
*
* ## Import
*
* TargetTcpProxy can be imported using any of these accepted formats:
*
* * `projects/{{project}}/global/targetTcpProxies/{{name}}`
*
* * `{{project}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, TargetTcpProxy can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/targetTCPProxy:TargetTCPProxy default projects/{{project}}/global/targetTcpProxies/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/targetTCPProxy:TargetTCPProxy default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/targetTCPProxy:TargetTCPProxy default {{name}}
* ```
*/
export declare class TargetTCPProxy extends pulumi.CustomResource {
/**
* Get an existing TargetTCPProxy 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?: TargetTCPProxyState, opts?: pulumi.CustomResourceOptions): TargetTCPProxy;
/**
* Returns true if the given object is an instance of TargetTCPProxy. 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 TargetTCPProxy;
/**
* A reference to the BackendService resource.
*
*
* - - -
*/
readonly backendService: pulumi.Output<string>;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | 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>;
/**
* Specifies the type of proxy header to append before sending data to
* the backend.
* Default value is `NONE`.
* Possible values are: `NONE`, `PROXY_V1`.
*/
readonly proxyHeader: pulumi.Output<string | undefined>;
/**
* The unique identifier for the resource.
*/
readonly proxyId: pulumi.Output<number>;
/**
* The URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Create a TargetTCPProxy 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: TargetTCPProxyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TargetTCPProxy resources.
*/
export interface TargetTCPProxyState {
/**
* A reference to the BackendService resource.
*
*
* - - -
*/
backendService?: pulumi.Input<string>;
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* 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>;
/**
* Specifies the type of proxy header to append before sending data to
* the backend.
* Default value is `NONE`.
* Possible values are: `NONE`, `PROXY_V1`.
*/
proxyHeader?: pulumi.Input<string>;
/**
* The unique identifier for the resource.
*/
proxyId?: pulumi.Input<number>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TargetTCPProxy resource.
*/
export interface TargetTCPProxyArgs {
/**
* A reference to the BackendService resource.
*
*
* - - -
*/
backendService: pulumi.Input<string>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* 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>;
/**
* Specifies the type of proxy header to append before sending data to
* the backend.
* Default value is `NONE`.
* Possible values are: `NONE`, `PROXY_V1`.
*/
proxyHeader?: pulumi.Input<string>;
}