2018-11-13 21:33:51 +00:00
|
|
|
---
|
|
|
|
# ----------------------------------------------------------------------------
|
|
|
|
#
|
|
|
|
# *** 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_monitoring_group"
|
|
|
|
sidebar_current: "docs-google-monitoring-group"
|
|
|
|
description: |-
|
|
|
|
The description of a dynamic collection of monitored resources.
|
|
|
|
---
|
|
|
|
|
|
|
|
# google\_monitoring\_group
|
|
|
|
|
|
|
|
The description of a dynamic collection of monitored resources. Each group
|
|
|
|
has a filter that is matched against monitored resources and their
|
|
|
|
associated metadata. If a group's filter matches an available monitored
|
|
|
|
resource, then that resource is a member of that group.
|
|
|
|
|
|
|
|
|
|
|
|
To get more information about Group, see:
|
|
|
|
|
|
|
|
* [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.groups)
|
|
|
|
* How-to Guides
|
|
|
|
* [Official Documentation](https://cloud.google.com/monitoring/groups/)
|
|
|
|
|
|
|
|
<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_group_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 - Monitoring Group Basic
|
|
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
resource "google_monitoring_group" "basic" {
|
|
|
|
display_name = "New Test Group"
|
|
|
|
|
|
|
|
filter = "resource.metadata.region=\"europe-west2\""
|
|
|
|
}
|
|
|
|
```
|
|
|
|
<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_group_subgroup&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 - Monitoring Group Subgroup
|
|
|
|
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
resource "google_monitoring_group" "parent" {
|
|
|
|
display_name = "New Test SubGroup"
|
|
|
|
filter = "resource.metadata.region=\"europe-west2\""
|
|
|
|
}
|
|
|
|
|
|
|
|
resource "google_monitoring_group" "subgroup" {
|
|
|
|
display_name = "New Test SubGroup"
|
|
|
|
filter = "resource.metadata.region=\"europe-west2\""
|
|
|
|
parent_name = "${google_monitoring_group.parent.name}"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Argument Reference
|
|
|
|
|
|
|
|
The following arguments are supported:
|
|
|
|
|
|
|
|
|
|
|
|
* `display_name` -
|
|
|
|
(Required)
|
|
|
|
A user-assigned name for this group, used only for display
|
|
|
|
purposes.
|
|
|
|
|
|
|
|
* `filter` -
|
|
|
|
(Required)
|
|
|
|
The filter used to determine which monitored resources
|
|
|
|
belong to this group.
|
|
|
|
|
|
|
|
|
|
|
|
- - -
|
|
|
|
|
|
|
|
|
|
|
|
* `parent_name` -
|
|
|
|
(Optional)
|
|
|
|
The name of the group's parent, if it has one. The format is
|
|
|
|
"projects/{project_id_or_number}/groups/{group_id}". For
|
|
|
|
groups with no parent, parentName is the empty string, "".
|
|
|
|
|
|
|
|
* `is_cluster` -
|
|
|
|
(Optional)
|
|
|
|
If true, the members of this group are considered to be a
|
|
|
|
cluster. The system can perform additional analysis on
|
|
|
|
groups that are clusters.
|
|
|
|
* `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:
|
|
|
|
|
|
|
|
|
|
|
|
* `name` -
|
|
|
|
A unique identifier for this group. The format is
|
|
|
|
"projects/{project_id_or_number}/groups/{group_id}".
|
|
|
|
|
|
|
|
|
2018-12-13 01:28:44 +00:00
|
|
|
## Timeouts
|
|
|
|
|
|
|
|
This resource provides the following
|
|
|
|
[Timeouts](/docs/configuration/resources.html#timeouts) configuration options:
|
|
|
|
|
|
|
|
- `create` - Default is 4 minutes.
|
|
|
|
- `update` - Default is 4 minutes.
|
|
|
|
- `delete` - Default is 4 minutes.
|
2018-11-13 21:33:51 +00:00
|
|
|
|
|
|
|
## Import
|
|
|
|
|
|
|
|
Group can be imported using any of these accepted formats:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ terraform import google_monitoring_group.default {{name}}
|
|
|
|
```
|
2018-12-18 21:04:43 +00:00
|
|
|
|
2018-12-20 18:29:39 +00:00
|
|
|
-> If you're importing a resource with beta features, make sure to include `-provider=google-beta`
|
2018-12-18 21:04:43 +00:00
|
|
|
as an argument so that Terraform uses the correct provider to import your resource.
|