blob: d3da6297b76a198fcd2bc9528c8ea62737c7b4a8 [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: "Cloud (Stackdriver) Monitoring"
description: |-
A Service is a discrete, autonomous, and network-accessible unit,
designed to solve an individual concern.
---
# google\_monitoring\_custom\_service
A Service is a discrete, autonomous, and network-accessible unit,
designed to solve an individual concern. In Cloud Monitoring,
a Service acts as the root resource under which operational aspects of
the service are accessible
To get more information about Service, see:
* [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services)
* How-to Guides
* [Service Monitoring](https://cloud.google.com/monitoring/service-monitoring)
* [Monitoring API Documentation](https://cloud.google.com/monitoring/api/v3/)
* [Service-orientation on Wikipedia](https://en.wikipedia.org/wiki/Service-orientation)
<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=monitoring_service_custom&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 - Monitoring Service Custom
```hcl
resource "google_monitoring_custom_service" "custom" {
service_id = "custom-srv"
display_name = "My Custom Service custom-srv"
telemetry {
resource_name = "//product.googleapis.com/foo/foo/services/test"
}
user_labels = {
my_key = "my_value"
my_other_key = "my_other_value"
}
}
```
## Argument Reference
The following arguments are supported:
- - -
* `display_name` -
(Optional)
Name used for UI elements listing this Service.
* `user_labels` -
(Optional)
Labels which have been used to annotate the service. Label keys must start
with a letter. Label keys and values may contain lowercase letters,
numbers, underscores, and dashes. Label keys and values have a maximum
length of 63 characters, and must be less than 128 bytes in size. Up to 64
label entries may be stored. For labels which do not have a semantic value,
the empty string may be supplied for the label value.
* `telemetry` -
(Optional)
Configuration for how to query telemetry on a Service.
Structure is [documented below](#nested_telemetry).
* `service_id` -
(Optional)
An optional service ID to use. If not given, the server will generate a
service ID.
* `project` - (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
<a name="nested_telemetry"></a>The `telemetry` block supports:
* `resource_name` -
(Optional)
The full name of the resource that defines this service.
Formatted as described in
https://cloud.google.com/apis/design/resource_names.
## 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 full resource name for this service. The syntax is:
projects/[PROJECT_ID]/services/[SERVICE_ID].
## 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:
* `{{name}}`
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 = "{{name}}"
to = google_monitoring_custom_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_monitoring_custom_service.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).