@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
382 lines • 15.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Represents a RegionTargetTcpProxy resource, which is used by one or more
* forwarding rules to route incoming TCP requests to a regional TCP proxy load
* balancer.
*
* To get more information about RegionTargetTcpProxy, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionTargetTcpProxies)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/load-balancing/docs/tcp/internal-proxy)
*
* ## Example Usage
*
* ### Region Target Tcp Proxy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* name: "health-check",
* region: "europe-west4",
* timeoutSec: 1,
* checkIntervalSec: 1,
* tcpHealthCheck: {
* port: 80,
* },
* });
* const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
* name: "backend-service",
* protocol: "TCP",
* timeoutSec: 10,
* region: "europe-west4",
* healthChecks: defaultRegionHealthCheck.id,
* loadBalancingScheme: "INTERNAL_MANAGED",
* });
* const _default = new gcp.compute.RegionTargetTcpProxy("default", {
* name: "test-proxy",
* region: "europe-west4",
* backendService: defaultRegionBackendService.id,
* });
* ```
* ### Region Target Tcp Proxy Basic Beta
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* name: "health-check",
* region: "europe-west4",
* timeoutSec: 1,
* checkIntervalSec: 1,
* tcpHealthCheck: {
* port: 80,
* },
* });
* const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
* name: "backend-service",
* protocol: "TCP",
* timeoutSec: 10,
* region: "europe-west4",
* healthChecks: defaultRegionHealthCheck.id,
* loadBalancingScheme: "EXTERNAL_MANAGED",
* });
* const _default = new gcp.compute.RegionTargetTcpProxy("default", {
* name: "test-proxy",
* region: "europe-west4",
* loadBalancingScheme: "EXTERNAL_MANAGED",
* backendService: defaultRegionBackendService.id,
* });
* ```
* ### Region Target Tcp Proxy Backendless
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.RegionTargetTcpProxy("default", {
* name: "test-proxy",
* region: "europe-west4",
* loadBalancingScheme: "INTERNAL_MANAGED",
* });
* ```
* ### Region Target Tcp Proxy Tls Route
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.RegionTargetTcpProxy("default", {
* name: "test-proxy",
* region: "europe-west4",
* loadBalancingScheme: "EXTERNAL_MANAGED",
* });
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* name: "health-check",
* region: "europe-west4",
* timeoutSec: 1,
* checkIntervalSec: 1,
* tcpHealthCheck: {
* port: 80,
* },
* });
* const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
* name: "backend-service",
* protocol: "TCP",
* timeoutSec: 10,
* region: "europe-west4",
* healthChecks: defaultRegionHealthCheck.id,
* loadBalancingScheme: "EXTERNAL_MANAGED",
* });
* const defaultTlsRoute = new gcp.networkservices.TlsRoute("default", {
* name: "tls-route-check",
* location: "europe-west4",
* targetProxies: [_default.selfLink],
* rules: [{
* matches: [{
* sniHosts: ["example.com"],
* }],
* action: {
* destinations: [{
* serviceName: defaultRegionBackendService.selfLink,
* }],
* },
* }],
* });
* ```
*
* ## Import
*
* RegionTargetTcpProxy can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/targetTcpProxies/{{name}}`
* * `{{project}}/{{region}}/{{name}}`
* * `{{region}}/{{name}}`
* * `{{name}}`
*
* When using the `pulumi import` command, RegionTargetTcpProxy can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/regionTargetTcpProxy:RegionTargetTcpProxy default projects/{{project}}/regions/{{region}}/targetTcpProxies/{{name}}
* $ pulumi import gcp:compute/regionTargetTcpProxy:RegionTargetTcpProxy default {{project}}/{{region}}/{{name}}
* $ pulumi import gcp:compute/regionTargetTcpProxy:RegionTargetTcpProxy default {{region}}/{{name}}
* $ pulumi import gcp:compute/regionTargetTcpProxy:RegionTargetTcpProxy default {{name}}
* ```
*/
export declare class RegionTargetTcpProxy extends pulumi.CustomResource {
/**
* Get an existing RegionTargetTcpProxy 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?: RegionTargetTcpProxyState, opts?: pulumi.CustomResourceOptions): RegionTargetTcpProxy;
/**
* Returns true if the given object is an instance of RegionTargetTcpProxy. 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 RegionTargetTcpProxy;
/**
* A reference to the BackendService resource. This field is optional when
* the loadBalancingScheme (available in beta) is specified.
*/
readonly backendService: pulumi.Output<string | undefined>;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* (Optional, Beta)
* Specifies the load balancer type. A target TCP proxy created for one type
* of load balancer cannot be used with another. For more information, refer
* to [Summary of types of Google Cloud load balancers](https://docs.cloud.google.com/load-balancing/docs/load-balancing-overview#summary-gclb).
* Possible values are: `EXTERNAL_MANAGED`, `INTERNAL_MANAGED`.
*/
readonly loadBalancingScheme: 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 Region in which the created target TCP 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>;
/**
* Create a RegionTargetTcpProxy 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?: RegionTargetTcpProxyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RegionTargetTcpProxy resources.
*/
export interface RegionTargetTcpProxyState {
/**
* A reference to the BackendService resource. This field is optional when
* the loadBalancingScheme (available in beta) is specified.
*/
backendService?: pulumi.Input<string | undefined>;
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* (Optional, Beta)
* Specifies the load balancer type. A target TCP proxy created for one type
* of load balancer cannot be used with another. For more information, refer
* to [Summary of types of Google Cloud load balancers](https://docs.cloud.google.com/load-balancing/docs/load-balancing-overview#summary-gclb).
* Possible values are: `EXTERNAL_MANAGED`, `INTERNAL_MANAGED`.
*/
loadBalancingScheme?: pulumi.Input<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.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* 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 | undefined>;
/**
* 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 | undefined>;
/**
* The unique identifier for the resource.
*/
proxyId?: pulumi.Input<number | undefined>;
/**
* The Region in which the created target TCP proxy should reside.
* If it is not provided, the provider region is used.
*/
region?: pulumi.Input<string | undefined>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a RegionTargetTcpProxy resource.
*/
export interface RegionTargetTcpProxyArgs {
/**
* A reference to the BackendService resource. This field is optional when
* the loadBalancingScheme (available in beta) is specified.
*/
backendService?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* (Optional, Beta)
* Specifies the load balancer type. A target TCP proxy created for one type
* of load balancer cannot be used with another. For more information, refer
* to [Summary of types of Google Cloud load balancers](https://docs.cloud.google.com/load-balancing/docs/load-balancing-overview#summary-gclb).
* Possible values are: `EXTERNAL_MANAGED`, `INTERNAL_MANAGED`.
*/
loadBalancingScheme?: pulumi.Input<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.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* 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 | undefined>;
/**
* 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 | undefined>;
/**
* The Region in which the created target TCP proxy should reside.
* If it is not provided, the provider region is used.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=regionTargetTcpProxy.d.ts.map