mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-09-07 17:46:43 +00:00
231 lines
8.0 KiB
Markdown
231 lines
8.0 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_ssl_certificate"
|
|
sidebar_current: "docs-google-compute-ssl-certificate"
|
|
description: |-
|
|
An SslCertificate resource, used for HTTPS load balancing.
|
|
---
|
|
|
|
# google\_compute\_ssl\_certificate
|
|
|
|
An SslCertificate resource, used for HTTPS load balancing. This resource
|
|
provides a mechanism to upload an SSL key and certificate to
|
|
the load balancer to serve secure connections from the user.
|
|
|
|
|
|
To get more information about SslCertificate, see:
|
|
|
|
* [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/sslCertificates)
|
|
* How-to Guides
|
|
* [Official Documentation](https://cloud.google.com/load-balancing/docs/ssl-certificates)
|
|
|
|
<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=ssl_certificate_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 - Ssl Certificate Basic
|
|
|
|
|
|
```hcl
|
|
resource "google_compute_ssl_certificate" "default" {
|
|
name_prefix = "my-certificate-"
|
|
description = "a description"
|
|
private_key = "${file("path/to/private.key")}"
|
|
certificate = "${file("path/to/certificate.crt")}"
|
|
|
|
lifecycle {
|
|
create_before_destroy = true
|
|
}
|
|
}
|
|
```
|
|
<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=ssl_certificate_random_provider&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 - Ssl Certificate Random Provider
|
|
|
|
|
|
```hcl
|
|
# You may also want to control name generation explicitly:
|
|
resource "google_compute_ssl_certificate" "default" {
|
|
# The name will contain 8 random hex digits,
|
|
# e.g. "my-certificate-48ab27cd2a"
|
|
name = "${random_id.certificate.hex}"
|
|
private_key = "${file("path/to/private.key")}"
|
|
certificate = "${file("path/to/certificate.crt")}"
|
|
|
|
lifecycle {
|
|
create_before_destroy = true
|
|
}
|
|
}
|
|
|
|
resource "random_id" "certificate" {
|
|
byte_length = 4
|
|
prefix = "my-certificate-"
|
|
|
|
# For security, do not expose raw certificate values in the output
|
|
keepers {
|
|
private_key = "${base64sha256(file("path/to/private.key"))}"
|
|
certificate = "${base64sha256(file("path/to/certificate.crt"))}"
|
|
}
|
|
}
|
|
```
|
|
<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=ssl_certificate_target_https_proxies&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 - Ssl Certificate Target Https Proxies
|
|
|
|
|
|
```hcl
|
|
// Using with Target HTTPS Proxies
|
|
//
|
|
// SSL certificates cannot be updated after creation. In order to apply
|
|
// the specified configuration, Terraform will destroy the existing
|
|
// resource and create a replacement. To effectively use an SSL
|
|
// certificate resource with a Target HTTPS Proxy resource, it's
|
|
// recommended to specify create_before_destroy in a lifecycle block.
|
|
// Either omit the Instance Template name attribute, specify a partial
|
|
// name with name_prefix, or use random_id resource. Example:
|
|
|
|
resource "google_compute_ssl_certificate" "default" {
|
|
name_prefix = "my-certificate-"
|
|
private_key = "${file("path/to/private.key")}"
|
|
certificate = "${file("path/to/certificate.crt")}"
|
|
|
|
lifecycle {
|
|
create_before_destroy = true
|
|
}
|
|
}
|
|
|
|
resource "google_compute_target_https_proxy" "default" {
|
|
name = "test-proxy"
|
|
url_map = "${google_compute_url_map.default.self_link}"
|
|
ssl_certificates = ["${google_compute_ssl_certificate.default.self_link}"]
|
|
}
|
|
|
|
resource "google_compute_url_map" "default" {
|
|
name = "url-map"
|
|
description = "a description"
|
|
|
|
default_service = "${google_compute_backend_service.default.self_link}"
|
|
|
|
host_rule {
|
|
hosts = ["mysite.com"]
|
|
path_matcher = "allpaths"
|
|
}
|
|
|
|
path_matcher {
|
|
name = "allpaths"
|
|
default_service = "${google_compute_backend_service.default.self_link}"
|
|
|
|
path_rule {
|
|
paths = ["/*"]
|
|
service = "${google_compute_backend_service.default.self_link}"
|
|
}
|
|
}
|
|
}
|
|
|
|
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.self_link}"]
|
|
}
|
|
|
|
resource "google_compute_http_health_check" "default" {
|
|
name = "http-health-check"
|
|
request_path = "/"
|
|
check_interval_sec = 1
|
|
timeout_sec = 1
|
|
}
|
|
```
|
|
|
|
## Argument Reference
|
|
|
|
The following arguments are supported:
|
|
|
|
|
|
* `certificate` -
|
|
(Required)
|
|
The certificate in PEM format.
|
|
The certificate chain must be no greater than 5 certs long.
|
|
The chain must include at least one intermediate cert.
|
|
|
|
* `private_key` -
|
|
(Required)
|
|
The write-only private key in PEM format.
|
|
|
|
|
|
- - -
|
|
|
|
|
|
* `description` -
|
|
(Optional)
|
|
An optional description of this resource.
|
|
|
|
* `name` -
|
|
(Optional)
|
|
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.
|
|
* `project` - (Optional) The ID of the project in which the resource belongs.
|
|
If it is not provided, the provider project is used.
|
|
|
|
|
|
* `name_prefix` - (Optional) Creates a unique name beginning with the
|
|
specified prefix. Conflicts with `name`.
|
|
|
|
## Attributes Reference
|
|
|
|
In addition to the arguments listed above, the following computed attributes are exported:
|
|
|
|
|
|
* `creation_timestamp` -
|
|
Creation timestamp in RFC3339 text format.
|
|
|
|
* `certificate_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.
|
|
- `delete` - Default is 4 minutes.
|
|
|
|
## Import
|
|
|
|
SslCertificate can be imported using any of these accepted formats:
|
|
|
|
```
|
|
$ terraform import google_compute_ssl_certificate.default projects/{{project}}/global/sslCertificates/{{name}}
|
|
$ terraform import google_compute_ssl_certificate.default {{project}}/{{name}}
|
|
$ terraform import google_compute_ssl_certificate.default {{name}}
|
|
```
|