| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** AUTO GENERATED CODE *** Type: MMv1 *** |
| # |
| # ---------------------------------------------------------------------------- |
| # |
| # 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. |
| # |
| # ---------------------------------------------------------------------------- |
| subcategory: "Compute Engine" |
| description: |- |
| Represents a TargetHttpProxy resource, which is used by one or more global |
| forwarding rule to route incoming HTTP requests to a URL map. |
| --- |
| |
| # google\_compute\_target\_http\_proxy |
| |
| 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) |
| |
| <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_http_proxy_basic&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%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 Http Proxy Basic |
| |
| |
| ```hcl |
| resource "google_compute_target_http_proxy" "default" { |
| name = "test-proxy" |
| url_map = google_compute_url_map.default.id |
| } |
| |
| resource "google_compute_url_map" "default" { |
| name = "url-map" |
| default_service = google_compute_backend_service.default.id |
| |
| host_rule { |
| hosts = ["mysite.com"] |
| path_matcher = "allpaths" |
| } |
| |
| path_matcher { |
| name = "allpaths" |
| default_service = google_compute_backend_service.default.id |
| |
| path_rule { |
| paths = ["/*"] |
| service = google_compute_backend_service.default.id |
| } |
| } |
| } |
| |
| resource "google_compute_backend_service" "default" { |
| name = "backend-service" |
| port_name = "http" |
| protocol = "HTTP" |
| timeout_sec = 10 |
| |
| health_checks = [google_compute_http_health_check.default.id] |
| } |
| |
| resource "google_compute_http_health_check" "default" { |
| name = "http-health-check" |
| request_path = "/" |
| check_interval_sec = 1 |
| timeout_sec = 1 |
| } |
| ``` |
| <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_http_proxy_http_keep_alive_timeout&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%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 Http Proxy Http Keep Alive Timeout |
| |
| |
| ```hcl |
| resource "google_compute_target_http_proxy" "default" { |
| name = "test-http-keep-alive-timeout-proxy" |
| http_keep_alive_timeout_sec = 610 |
| url_map = google_compute_url_map.default.id |
| } |
| |
| resource "google_compute_url_map" "default" { |
| name = "url-map" |
| default_service = google_compute_backend_service.default.id |
| |
| host_rule { |
| hosts = ["mysite.com"] |
| path_matcher = "allpaths" |
| } |
| |
| path_matcher { |
| name = "allpaths" |
| default_service = google_compute_backend_service.default.id |
| |
| path_rule { |
| paths = ["/*"] |
| service = google_compute_backend_service.default.id |
| } |
| } |
| } |
| |
| resource "google_compute_backend_service" "default" { |
| name = "backend-service" |
| port_name = "http" |
| protocol = "HTTP" |
| timeout_sec = 10 |
| load_balancing_scheme = "EXTERNAL_MANAGED" |
| |
| health_checks = [google_compute_http_health_check.default.id] |
| } |
| |
| resource "google_compute_http_health_check" "default" { |
| name = "http-health-check" |
| request_path = "/" |
| check_interval_sec = 1 |
| timeout_sec = 1 |
| } |
| ``` |
| <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_http_proxy_https_redirect&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%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 Http Proxy Https Redirect |
| |
| |
| ```hcl |
| resource "google_compute_target_http_proxy" "default" { |
| name = "test-https-redirect-proxy" |
| url_map = google_compute_url_map.default.id |
| } |
| |
| resource "google_compute_url_map" "default" { |
| name = "url-map" |
| default_url_redirect { |
| https_redirect = true |
| strip_query = false |
| } |
| } |
| ``` |
| |
| ## 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. |
| |
| * `url_map` - |
| (Required) |
| A reference to the UrlMap resource that defines the mapping from URL |
| to the BackendService. |
| |
| |
| - - - |
| |
| |
| * `description` - |
| (Optional) |
| An optional description of this resource. |
| |
| * `proxy_bind` - |
| (Optional) |
| This field only applies when the forwarding rule that references |
| this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. |
| |
| * `http_keep_alive_timeout_sec` - |
| (Optional) |
| 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 (610 seconds) will be used. For Global |
| external HTTP(S) load balancer, the minimum allowed value is 5 seconds and |
| the maximum allowed value is 1200 seconds. For Global external HTTP(S) |
| load balancer (classic), this option is not available publicly. |
| |
| * `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: |
| |
| * `id` - an identifier for the resource with format `projects/{{project}}/global/targetHttpProxies/{{name}}` |
| |
| * `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](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| |
| - `create` - Default is 20 minutes. |
| - `update` - Default is 20 minutes. |
| - `delete` - Default is 20 minutes. |
| |
| ## Import |
| |
| |
| TargetHttpProxy can be imported using any of these accepted formats: |
| |
| * `projects/{{project}}/global/targetHttpProxies/{{name}}` |
| * `{{project}}/{{name}}` |
| * `{{name}}` |
| |
| |
| In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import TargetHttpProxy using one of the formats above. For example: |
| |
| ```tf |
| import { |
| id = "projects/{{project}}/global/targetHttpProxies/{{name}}" |
| to = google_compute_target_http_proxy.default |
| } |
| ``` |
| |
| When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), TargetHttpProxy can be imported using one of the formats above. For example: |
| |
| ``` |
| $ terraform import google_compute_target_http_proxy.default projects/{{project}}/global/targetHttpProxies/{{name}} |
| $ terraform import google_compute_target_http_proxy.default {{project}}/{{name}} |
| $ terraform import google_compute_target_http_proxy.default {{name}} |
| ``` |
| |
| ## User Project Overrides |
| |
| This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |