mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-07-08 19:18:30 +00:00
139 lines
4.5 KiB
Markdown
139 lines
4.5 KiB
Markdown
---
|
|
# ----------------------------------------------------------------------------
|
|
#
|
|
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
|
|
#
|
|
# ----------------------------------------------------------------------------
|
|
#
|
|
# This file is automatically generated by Magic Modules and manual
|
|
# changes will be clobbered when the file is regenerated.
|
|
#
|
|
# Please read more about how to change this file in
|
|
# .github/CONTRIBUTING.md.
|
|
#
|
|
# ----------------------------------------------------------------------------
|
|
layout: "google"
|
|
page_title: "Google: google_compute_target_tcp_proxy"
|
|
sidebar_current: "docs-google-compute-target-tcp-proxy"
|
|
description: |-
|
|
Represents a TargetTcpProxy resource, which is used by one or more
|
|
global forwarding rule to route incoming TCP requests to a Backend
|
|
service.
|
|
---
|
|
|
|
# google\_compute\_target\_tcp\_proxy
|
|
|
|
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)
|
|
|
|
<div class = "oics-button" style="float: right; margin: 0 0 -15px">
|
|
<a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=target_tcp_proxy_basic&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
|
|
<img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
|
|
</a>
|
|
</div>
|
|
## Example Usage - Target Tcp Proxy Basic
|
|
|
|
|
|
```hcl
|
|
resource "google_compute_target_tcp_proxy" "default" {
|
|
name = "test-proxy"
|
|
backend_service = "${google_compute_backend_service.default.self_link}"
|
|
}
|
|
|
|
resource "google_compute_backend_service" "default" {
|
|
name = "backend-service"
|
|
protocol = "TCP"
|
|
timeout_sec = 10
|
|
|
|
health_checks = ["${google_compute_health_check.default.self_link}"]
|
|
}
|
|
|
|
resource "google_compute_health_check" "default" {
|
|
name = "health-check"
|
|
timeout_sec = 1
|
|
check_interval_sec = 1
|
|
|
|
tcp_health_check {
|
|
port = "443"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Argument Reference
|
|
|
|
The following arguments are supported:
|
|
|
|
|
|
* `name` -
|
|
(Required)
|
|
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]([-a-z0-9]*[a-z0-9])?` 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.
|
|
|
|
* `backend_service` -
|
|
(Required)
|
|
A reference to the BackendService resource.
|
|
|
|
|
|
- - -
|
|
|
|
|
|
* `description` -
|
|
(Optional)
|
|
An optional description of this resource.
|
|
|
|
* `proxy_header` -
|
|
(Optional)
|
|
Specifies the type of proxy header to append before sending data to
|
|
the backend, either NONE or PROXY_V1. The default is NONE.
|
|
* `project` - (Optional) The ID of the project in which the resource belongs.
|
|
If it is not provided, the provider project is used.
|
|
|
|
|
|
## Attributes Reference
|
|
|
|
In addition to the arguments listed above, the following computed attributes are exported:
|
|
|
|
|
|
* `creation_timestamp` -
|
|
Creation timestamp in RFC3339 text format.
|
|
|
|
* `proxy_id` -
|
|
The unique identifier for the resource.
|
|
* `self_link` - The URI of the created resource.
|
|
|
|
|
|
## Timeouts
|
|
|
|
This resource provides the following
|
|
[Timeouts](/docs/configuration/resources.html#timeouts) configuration options:
|
|
|
|
- `create` - Default is 4 minutes.
|
|
- `update` - Default is 4 minutes.
|
|
- `delete` - Default is 4 minutes.
|
|
|
|
## Import
|
|
|
|
TargetTcpProxy can be imported using any of these accepted formats:
|
|
|
|
```
|
|
$ terraform import google_compute_target_tcp_proxy.default projects/{{project}}/global/targetTcpProxies/{{name}}
|
|
$ terraform import google_compute_target_tcp_proxy.default {{project}}/{{name}}
|
|
$ terraform import google_compute_target_tcp_proxy.default {{name}}
|
|
```
|
|
|
|
-> If you're importing a resource with beta features, make sure to include `-provider=google-beta`
|
|
as an argument so that Terraform uses the correct provider to import your resource.
|