| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** 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 TargetSslProxy resource, which is used by one or more |
| global forwarding rule to route incoming SSL requests to a backend |
| service. |
| --- |
| |
| # google\_compute\_target\_ssl\_proxy |
| |
| Represents a TargetSslProxy resource, which is used by one or more |
| global forwarding rule to route incoming SSL requests to a backend |
| service. |
| |
| |
| To get more information about TargetSslProxy, see: |
| |
| * [API documentation](https://cloud.google.com/compute/docs/reference/v1/targetSslProxies) |
| * How-to Guides |
| * [Setting Up SSL proxy for Google Cloud Load Balancing](https://cloud.google.com/compute/docs/load-balancing/tcp-ssl/) |
| |
| <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_ssl_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 Ssl Proxy Basic |
| |
| |
| ```hcl |
| resource "google_compute_target_ssl_proxy" "default" { |
| name = "test-proxy" |
| backend_service = google_compute_backend_service.default.id |
| ssl_certificates = [google_compute_ssl_certificate.default.id] |
| } |
| |
| resource "google_compute_ssl_certificate" "default" { |
| name = "default-cert" |
| private_key = file("path/to/private.key") |
| certificate = file("path/to/certificate.crt") |
| } |
| |
| resource "google_compute_backend_service" "default" { |
| name = "backend-service" |
| protocol = "SSL" |
| health_checks = [google_compute_health_check.default.id] |
| } |
| |
| resource "google_compute_health_check" "default" { |
| name = "health-check" |
| check_interval_sec = 1 |
| timeout_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. |
| Default value is `NONE`. |
| Possible values are: `NONE`, `PROXY_V1`. |
| |
| * `ssl_certificates` - |
| (Optional) |
| A list of SslCertificate resources that are used to authenticate |
| connections between users and the load balancer. At least one |
| SSL certificate must be specified. |
| |
| * `certificate_map` - |
| (Optional) |
| A reference to the CertificateMap resource uri that identifies a certificate map |
| associated with the given target proxy. This field can only be set for global target proxies. |
| Accepted format is `//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}`. |
| |
| * `ssl_policy` - |
| (Optional) |
| A reference to the SslPolicy resource that will be associated with |
| the TargetSslProxy resource. If not set, the TargetSslProxy |
| resource will not have any SSL policy configured. |
| |
| * `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/targetSslProxies/{{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 |
| |
| |
| TargetSslProxy can be imported using any of these accepted formats: |
| |
| * `projects/{{project}}/global/targetSslProxies/{{name}}` |
| * `{{project}}/{{name}}` |
| * `{{name}}` |
| |
| |
| In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import TargetSslProxy using one of the formats above. For example: |
| |
| ```tf |
| import { |
| id = "projects/{{project}}/global/targetSslProxies/{{name}}" |
| to = google_compute_target_ssl_proxy.default |
| } |
| ``` |
| |
| When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), TargetSslProxy can be imported using one of the formats above. For example: |
| |
| ``` |
| $ terraform import google_compute_target_ssl_proxy.default projects/{{project}}/global/targetSslProxies/{{name}} |
| $ terraform import google_compute_target_ssl_proxy.default {{project}}/{{name}} |
| $ terraform import google_compute_target_ssl_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). |