blob: 94587e3db697479db7c8088ce0f3d0571be79e49 [file] [log] [blame]
---
# ----------------------------------------------------------------------------
#
# *** 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: "Certificate manager"
description: |-
CertificateMap defines a collection of certificate configurations,
which are usable by any associated target proxies
---
# google\_certificate\_manager\_certificate\_map
CertificateMap defines a collection of certificate configurations,
which are usable by any associated 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=certificate_manager_certificate_map_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 - Certificate Manager Certificate Map Basic
```hcl
resource "google_certificate_manager_certificate_map" "default" {
name = "cert-map"
description = "My acceptance test certificate map"
labels = {
"terraform" : true,
"acc-test" : true,
}
}
```
## Argument Reference
The following arguments are supported:
* `name` -
(Required)
A user-defined name of the Certificate Map. Certificate Map names must be unique
globally and match the pattern `projects/*/locations/*/certificateMaps/*`.
- - -
* `description` -
(Optional)
A human-readable description of the resource.
* `labels` -
(Optional)
Set of labels associated with a Certificate Map resource.
**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field `effective_labels` for all of the labels present on the resource.
* `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}}/locations/global/certificateMaps/{{name}}`
* `create_time` -
Creation timestamp of a Certificate Map. Timestamp is in RFC3339 UTC "Zulu" format,
accurate to nanoseconds with up to nine fractional digits.
Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
* `update_time` -
Update timestamp of a Certificate Map. Timestamp is in RFC3339 UTC "Zulu" format,
accurate to nanoseconds with up to nine fractional digits.
Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
* `gclb_targets` -
A list of target proxies that use this Certificate Map
Structure is [documented below](#nested_gclb_targets).
* `terraform_labels` -
The combination of labels configured directly on the resource
and default labels configured on the provider.
* `effective_labels` -
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
<a name="nested_gclb_targets"></a>The `gclb_targets` block contains:
* `ip_configs` -
(Optional)
An IP configuration where this Certificate Map is serving
Structure is [documented below](#nested_ip_configs).
* `target_https_proxy` -
(Optional)
Proxy name must be in the format projects/*/locations/*/targetHttpsProxies/*.
This field is part of a union field `target_proxy`: Only one of `targetHttpsProxy` or
`targetSslProxy` may be set.
* `target_ssl_proxy` -
(Optional)
Proxy name must be in the format projects/*/locations/*/targetSslProxies/*.
This field is part of a union field `target_proxy`: Only one of `targetHttpsProxy` or
`targetSslProxy` may be set.
<a name="nested_ip_configs"></a>The `ip_configs` block supports:
* `ip_address` -
(Optional)
An external IP address
* `ports` -
(Optional)
A list of ports
## 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
CertificateMap can be imported using any of these accepted formats:
* `projects/{{project}}/locations/global/certificateMaps/{{name}}`
* `{{project}}/{{name}}`
* `{{name}}`
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CertificateMap using one of the formats above. For example:
```tf
import {
id = "projects/{{project}}/locations/global/certificateMaps/{{name}}"
to = google_certificate_manager_certificate_map.default
}
```
When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), CertificateMap can be imported using one of the formats above. For example:
```
$ terraform import google_certificate_manager_certificate_map.default projects/{{project}}/locations/global/certificateMaps/{{name}}
$ terraform import google_certificate_manager_certificate_map.default {{project}}/{{name}}
$ terraform import google_certificate_manager_certificate_map.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).