v5.18.0/website/docs/r/compute_region_ssl_certificate.html.markdown - terraform-provider-google-beta - Git at Google

 ---
 # ----------------------------------------------------------------------------
 #
 #     ***     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: |-
   A RegionSslCertificate resource, used for HTTPS load balancing.
 ---

 # google\_compute\_region\_ssl\_certificate

 A RegionSslCertificate 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 RegionSslCertificate, see:

 * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionSslCertificates)
 * How-to Guides
     * [Official Documentation](https://cloud.google.com/load-balancing/docs/ssl-certificates)

 ~> **Warning:** All arguments including the following potentially sensitive
 values will be stored in the raw state as plain text: `certificate`, `private_key`.
 [Read more about sensitive data in state](https://www.terraform.io/language/state/sensitive-data).

 <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=region_ssl_certificate_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 - Region Ssl Certificate Basic


 ```hcl
 resource "google_compute_region_ssl_certificate" "default" {
   region      = "us-central1"
   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=region_ssl_certificate_random_provider&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 - Region Ssl Certificate Random Provider


 ```hcl
 # You may also want to control name generation explicitly:
 resource "google_compute_region_ssl_certificate" "default" {
   region   = "us-central1"

   # 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 = filebase64sha256("path/to/private.key")
     certificate = filebase64sha256("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=region_ssl_certificate_target_https_proxies&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 - Region Ssl Certificate Target Https Proxies


 ```hcl
 // Using with Region 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_region_ssl_certificate" "default" {
   region      = "us-central1"
   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_region_target_https_proxy" "default" {
   region           = "us-central1"
   name             = "test-proxy"
   url_map          = google_compute_region_url_map.default.id
   ssl_certificates = [google_compute_region_ssl_certificate.default.id]
 }

 resource "google_compute_region_url_map" "default" {
   region      = "us-central1"
   name        = "url-map"
   description = "a description"

   default_service = google_compute_region_backend_service.default.id

   host_rule {
     hosts        = ["mysite.com"]
     path_matcher = "allpaths"
   }

   path_matcher {
     name            = "allpaths"
     default_service = google_compute_region_backend_service.default.id

     path_rule {
       paths   = ["/*"]
       service = google_compute_region_backend_service.default.id
     }
   }
 }

 resource "google_compute_region_backend_service" "default" {
   region      = "us-central1"
   name        = "backend-service"
   protocol    = "HTTP"
   load_balancing_scheme = "INTERNAL_MANAGED"
   timeout_sec = 10

   health_checks = [google_compute_region_health_check.default.id]
 }

 resource "google_compute_region_health_check" "default" {
   region   = "us-central1"
   name     = "http-health-check"
   http_health_check {
     port = 80
   }
 }
 ```

 ## 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.
   **Note**: This property is sensitive and will not be displayed in the plan.

 * `private_key` -
   (Required)
   The write-only private key in PEM format.
   **Note**: This property is sensitive and will not be displayed in the plan.


 - - -


 * `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.

   These are in the same namespace as the managed SSL certificates.

 * `region` -
   (Optional)
   The Region in which the created regional ssl certificate should reside.
   If it is not provided, the provider region is used.

 * `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:

 * `id` - an identifier for the resource with format `projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}`

 * `creation_timestamp` -
   Creation timestamp in RFC3339 text format.

 * `expire_time` -
   Expire time of the certificate 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](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:

 - `create` - Default is 20 minutes.
 - `delete` - Default is 20 minutes.

 ## Import


 RegionSslCertificate can be imported using any of these accepted formats:

 * `projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}`
 * `{{project}}/{{region}}/{{name}}`
 * `{{region}}/{{name}}`
 * `{{name}}`


 In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RegionSslCertificate using one of the formats above. For example:

 ```tf
 import {
   id = "projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}"
   to = google_compute_region_ssl_certificate.default
 }
 ```

 When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), RegionSslCertificate can be imported using one of the formats above. For example:

 ```
 $ terraform import google_compute_region_ssl_certificate.default projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}
 $ terraform import google_compute_region_ssl_certificate.default {{project}}/{{region}}/{{name}}
 $ terraform import google_compute_region_ssl_certificate.default {{region}}/{{name}}
 $ terraform import google_compute_region_ssl_certificate.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).
	---
	# ----------------------------------------------------------------------------
	#
	# * 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: \|-
	A RegionSslCertificate resource, used for HTTPS load balancing.
	---

	# google\_compute\_region\_ssl\_certificate

	A RegionSslCertificate 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 RegionSslCertificate, see:

	* [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionSslCertificates)
	* How-to Guides
	* [Official Documentation](https://cloud.google.com/load-balancing/docs/ssl-certificates)

	~> Warning: All arguments including the following potentially sensitive
	values will be stored in the raw state as plain text: `certificate`, `private_key`.
	[Read more about sensitive data in state](https://www.terraform.io/language/state/sensitive-data).

	<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=region_ssl_certificate_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 - Region Ssl Certificate Basic


	```hcl
	resource "google_compute_region_ssl_certificate" "default" {
	region = "us-central1"
	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=region_ssl_certificate_random_provider&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 - Region Ssl Certificate Random Provider


	```hcl
	# You may also want to control name generation explicitly:
	resource "google_compute_region_ssl_certificate" "default" {
	region = "us-central1"

	# 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 = filebase64sha256("path/to/private.key")
	certificate = filebase64sha256("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=region_ssl_certificate_target_https_proxies&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 - Region Ssl Certificate Target Https Proxies


	```hcl
	// Using with Region 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_region_ssl_certificate" "default" {
	region = "us-central1"
	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_region_target_https_proxy" "default" {
	region = "us-central1"
	name = "test-proxy"
	url_map = google_compute_region_url_map.default.id
	ssl_certificates = [google_compute_region_ssl_certificate.default.id]
	}

	resource "google_compute_region_url_map" "default" {
	region = "us-central1"
	name = "url-map"
	description = "a description"

	default_service = google_compute_region_backend_service.default.id

	host_rule {
	hosts = ["mysite.com"]
	path_matcher = "allpaths"
	}

	path_matcher {
	name = "allpaths"
	default_service = google_compute_region_backend_service.default.id

	path_rule {
	paths = ["/*"]
	service = google_compute_region_backend_service.default.id
	}
	}
	}

	resource "google_compute_region_backend_service" "default" {
	region = "us-central1"
	name = "backend-service"
	protocol = "HTTP"
	load_balancing_scheme = "INTERNAL_MANAGED"
	timeout_sec = 10

	health_checks = [google_compute_region_health_check.default.id]
	}

	resource "google_compute_region_health_check" "default" {
	region = "us-central1"
	name = "http-health-check"
	http_health_check {
	port = 80
	}
	}
	```

	## 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.
	Note: This property is sensitive and will not be displayed in the plan.

	* `private_key` -
	(Required)
	The write-only private key in PEM format.
	Note: This property is sensitive and will not be displayed in the plan.


	- - -


	* `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.

	These are in the same namespace as the managed SSL certificates.

	* `region` -
	(Optional)
	The Region in which the created regional ssl certificate should reside.
	If it is not provided, the provider region is used.

	* `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:

	* `id` - an identifier for the resource with format `projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}`

	* `creation_timestamp` -
	Creation timestamp in RFC3339 text format.

	* `expire_time` -
	Expire time of the certificate 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](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:

	- `create` - Default is 20 minutes.
	- `delete` - Default is 20 minutes.

	## Import


	RegionSslCertificate can be imported using any of these accepted formats:

	* `projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}`
	* `{{project}}/{{region}}/{{name}}`
	* `{{region}}/{{name}}`
	* `{{name}}`


	In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RegionSslCertificate using one of the formats above. For example:

	```tf
	import {
	id = "projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}"
	to = google_compute_region_ssl_certificate.default
	}
	```

	When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), RegionSslCertificate can be imported using one of the formats above. For example:

	```
	$ terraform import google_compute_region_ssl_certificate.default projects/{{project}}/regions/{{region}}/sslCertificates/{{name}}
	$ terraform import google_compute_region_ssl_certificate.default {{project}}/{{region}}/{{name}}
	$ terraform import google_compute_region_ssl_certificate.default {{region}}/{{name}}
	$ terraform import google_compute_region_ssl_certificate.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).