| --- |
| # ---------------------------------------------------------------------------- |
| # |
| # *** 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: "Service Directory" |
| description: |- |
| An individual service. |
| --- |
| |
| # google\_service\_directory\_service |
| |
| An individual service. A service contains a name and optional metadata. |
| |
| ~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. |
| See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources. |
| |
| To get more information about Service, see: |
| |
| * [API documentation](https://cloud.google.com/service-directory/docs/reference/rest/v1beta1/projects.locations.namespaces.services) |
| * How-to Guides |
| * [Configuring a service](https://cloud.google.com/service-directory/docs/configuring-service-directory#configuring_a_service) |
| |
| <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=service_directory_service_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 - Service Directory Service Basic |
| |
| |
| ```hcl |
| resource "google_service_directory_namespace" "example" { |
| provider = google-beta |
| namespace_id = "example-namespace" |
| location = "us-central1" |
| } |
| |
| resource "google_service_directory_service" "example" { |
| provider = google-beta |
| service_id = "example-service" |
| namespace = google_service_directory_namespace.example.id |
| |
| metadata = { |
| stage = "prod" |
| region = "us-central1" |
| } |
| } |
| ``` |
| |
| ## Argument Reference |
| |
| The following arguments are supported: |
| |
| |
| * `namespace` - |
| (Required) |
| The resource name of the namespace this service will belong to. |
| |
| * `service_id` - |
| (Required) |
| The Resource ID must be 1-63 characters long, including digits, |
| lowercase letters or the hyphen character. |
| |
| |
| - - - |
| |
| |
| * `metadata` - |
| (Optional) |
| Metadata for the service. This data can be consumed |
| by service clients. The entire metadata dictionary may contain |
| up to 2000 characters, spread across all key-value pairs. |
| Metadata that goes beyond any these limits will be rejected. |
| |
| |
| ## Attributes Reference |
| |
| In addition to the arguments listed above, the following computed attributes are exported: |
| |
| * `id` - an identifier for the resource with format `{{name}}` |
| |
| * `name` - |
| The resource name for the service in the |
| format `projects/*/locations/*/namespaces/*/services/*`. |
| |
| |
| ## 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 |
| |
| |
| Service can be imported using any of these accepted formats: |
| |
| * `projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}` |
| * `{{project}}/{{location}}/{{namespace_id}}/{{service_id}}` |
| * `{{location}}/{{namespace_id}}/{{service_id}}` |
| |
| |
| In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Service using one of the formats above. For example: |
| |
| ```tf |
| import { |
| id = "projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}" |
| to = google_service_directory_service.default |
| } |
| ``` |
| |
| When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Service can be imported using one of the formats above. For example: |
| |
| ``` |
| $ terraform import google_service_directory_service.default projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}} |
| $ terraform import google_service_directory_service.default {{project}}/{{location}}/{{namespace_id}}/{{service_id}} |
| $ terraform import google_service_directory_service.default {{location}}/{{namespace_id}}/{{service_id}} |
| ``` |