Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. monitoring
  5. Group
Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.monitoring.Group

Explore with Pulumi AI

Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp

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:

Example Usage

Monitoring Group Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = new gcp.monitoring.Group("basic", {
    displayName: "tf-test MonitoringGroup",
    filter: "resource.metadata.region=\"europe-west2\"",
});
Copy
import pulumi
import pulumi_gcp as gcp

basic = gcp.monitoring.Group("basic",
    display_name="tf-test MonitoringGroup",
    filter="resource.metadata.region=\"europe-west2\"")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := monitoring.NewGroup(ctx, "basic", &monitoring.GroupArgs{
			DisplayName: pulumi.String("tf-test MonitoringGroup"),
			Filter:      pulumi.String("resource.metadata.region=\"europe-west2\""),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var basic = new Gcp.Monitoring.Group("basic", new()
    {
        DisplayName = "tf-test MonitoringGroup",
        Filter = "resource.metadata.region=\"europe-west2\"",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.Group;
import com.pulumi.gcp.monitoring.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var basic = new Group("basic", GroupArgs.builder()
            .displayName("tf-test MonitoringGroup")
            .filter("resource.metadata.region=\"europe-west2\"")
            .build());

    }
}
Copy
resources:
  basic:
    type: gcp:monitoring:Group
    properties:
      displayName: tf-test MonitoringGroup
      filter: resource.metadata.region="europe-west2"
Copy

Monitoring Group Subgroup

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const parent = new gcp.monitoring.Group("parent", {
    displayName: "tf-test MonitoringParentGroup",
    filter: "resource.metadata.region=\"europe-west2\"",
});
const subgroup = new gcp.monitoring.Group("subgroup", {
    displayName: "tf-test MonitoringSubGroup",
    filter: "resource.metadata.region=\"europe-west2\"",
    parentName: parent.name,
});
Copy
import pulumi
import pulumi_gcp as gcp

parent = gcp.monitoring.Group("parent",
    display_name="tf-test MonitoringParentGroup",
    filter="resource.metadata.region=\"europe-west2\"")
subgroup = gcp.monitoring.Group("subgroup",
    display_name="tf-test MonitoringSubGroup",
    filter="resource.metadata.region=\"europe-west2\"",
    parent_name=parent.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		parent, err := monitoring.NewGroup(ctx, "parent", &monitoring.GroupArgs{
			DisplayName: pulumi.String("tf-test MonitoringParentGroup"),
			Filter:      pulumi.String("resource.metadata.region=\"europe-west2\""),
		})
		if err != nil {
			return err
		}
		_, err = monitoring.NewGroup(ctx, "subgroup", &monitoring.GroupArgs{
			DisplayName: pulumi.String("tf-test MonitoringSubGroup"),
			Filter:      pulumi.String("resource.metadata.region=\"europe-west2\""),
			ParentName:  parent.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var parent = new Gcp.Monitoring.Group("parent", new()
    {
        DisplayName = "tf-test MonitoringParentGroup",
        Filter = "resource.metadata.region=\"europe-west2\"",
    });

    var subgroup = new Gcp.Monitoring.Group("subgroup", new()
    {
        DisplayName = "tf-test MonitoringSubGroup",
        Filter = "resource.metadata.region=\"europe-west2\"",
        ParentName = parent.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.Group;
import com.pulumi.gcp.monitoring.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var parent = new Group("parent", GroupArgs.builder()
            .displayName("tf-test MonitoringParentGroup")
            .filter("resource.metadata.region=\"europe-west2\"")
            .build());

        var subgroup = new Group("subgroup", GroupArgs.builder()
            .displayName("tf-test MonitoringSubGroup")
            .filter("resource.metadata.region=\"europe-west2\"")
            .parentName(parent.name())
            .build());

    }
}
Copy
resources:
  parent:
    type: gcp:monitoring:Group
    properties:
      displayName: tf-test MonitoringParentGroup
      filter: resource.metadata.region="europe-west2"
  subgroup:
    type: gcp:monitoring:Group
    properties:
      displayName: tf-test MonitoringSubGroup
      filter: resource.metadata.region="europe-west2"
      parentName: ${parent.name}
Copy

Create Group Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          display_name: Optional[str] = None,
          filter: Optional[str] = None,
          is_cluster: Optional[bool] = None,
          parent_name: Optional[str] = None,
          project: Optional[str] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: gcp:monitoring:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplegroupResourceResourceFromMonitoringgroup = new Gcp.Monitoring.Group("examplegroupResourceResourceFromMonitoringgroup", new()
{
    DisplayName = "string",
    Filter = "string",
    IsCluster = false,
    ParentName = "string",
    Project = "string",
});
Copy
example, err := monitoring.NewGroup(ctx, "examplegroupResourceResourceFromMonitoringgroup", &monitoring.GroupArgs{
	DisplayName: pulumi.String("string"),
	Filter:      pulumi.String("string"),
	IsCluster:   pulumi.Bool(false),
	ParentName:  pulumi.String("string"),
	Project:     pulumi.String("string"),
})
Copy
var examplegroupResourceResourceFromMonitoringgroup = new Group("examplegroupResourceResourceFromMonitoringgroup", GroupArgs.builder()
    .displayName("string")
    .filter("string")
    .isCluster(false)
    .parentName("string")
    .project("string")
    .build());
Copy
examplegroup_resource_resource_from_monitoringgroup = gcp.monitoring.Group("examplegroupResourceResourceFromMonitoringgroup",
    display_name="string",
    filter="string",
    is_cluster=False,
    parent_name="string",
    project="string")
Copy
const examplegroupResourceResourceFromMonitoringgroup = new gcp.monitoring.Group("examplegroupResourceResourceFromMonitoringgroup", {
    displayName: "string",
    filter: "string",
    isCluster: false,
    parentName: "string",
    project: "string",
});
Copy
type: gcp:monitoring:Group
properties:
    displayName: string
    filter: string
    isCluster: false
    parentName: string
    project: string
Copy

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Group resource accepts the following input properties:

DisplayName This property is required. string
A user-assigned name for this group, used only for display purposes.
Filter This property is required. string
The filter used to determine which monitored resources belong to this group.

IsCluster bool
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
ParentName string
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, "".
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
DisplayName This property is required. string
A user-assigned name for this group, used only for display purposes.
Filter This property is required. string
The filter used to determine which monitored resources belong to this group.

IsCluster bool
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
ParentName string
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, "".
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
displayName This property is required. String
A user-assigned name for this group, used only for display purposes.
filter This property is required. String
The filter used to determine which monitored resources belong to this group.

isCluster Boolean
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
parentName String
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, "".
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
displayName This property is required. string
A user-assigned name for this group, used only for display purposes.
filter This property is required. string
The filter used to determine which monitored resources belong to this group.

isCluster boolean
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
parentName string
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, "".
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
display_name This property is required. str
A user-assigned name for this group, used only for display purposes.
filter This property is required. str
The filter used to determine which monitored resources belong to this group.

is_cluster bool
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
parent_name str
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, "".
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
displayName This property is required. String
A user-assigned name for this group, used only for display purposes.
filter This property is required. String
The filter used to determine which monitored resources belong to this group.

isCluster Boolean
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
parentName String
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, "".
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
Id string
The provider-assigned unique ID for this managed resource.
Name string
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
id String
The provider-assigned unique ID for this managed resource.
name String
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
id string
The provider-assigned unique ID for this managed resource.
name string
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
id str
The provider-assigned unique ID for this managed resource.
name str
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
id String
The provider-assigned unique ID for this managed resource.
name String
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".

Look up Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        filter: Optional[str] = None,
        is_cluster: Optional[bool] = None,
        name: Optional[str] = None,
        parent_name: Optional[str] = None,
        project: Optional[str] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DisplayName string
A user-assigned name for this group, used only for display purposes.
Filter string
The filter used to determine which monitored resources belong to this group.

IsCluster bool
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
Name string
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
ParentName string
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, "".
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
DisplayName string
A user-assigned name for this group, used only for display purposes.
Filter string
The filter used to determine which monitored resources belong to this group.

IsCluster bool
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
Name string
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
ParentName string
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, "".
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
displayName String
A user-assigned name for this group, used only for display purposes.
filter String
The filter used to determine which monitored resources belong to this group.

isCluster Boolean
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
name String
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
parentName String
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, "".
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
displayName string
A user-assigned name for this group, used only for display purposes.
filter string
The filter used to determine which monitored resources belong to this group.

isCluster boolean
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
name string
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
parentName string
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, "".
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
display_name str
A user-assigned name for this group, used only for display purposes.
filter str
The filter used to determine which monitored resources belong to this group.

is_cluster bool
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
name str
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
parent_name str
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, "".
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
displayName String
A user-assigned name for this group, used only for display purposes.
filter String
The filter used to determine which monitored resources belong to this group.

isCluster Boolean
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
name String
A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".
parentName String
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, "".
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Import

Group can be imported using any of these accepted formats:

  • {{project}}/{{name}}

  • {{project}} {{name}}

  • {{name}}

When using the pulumi import command, Group can be imported using one of the formats above. For example:

$ pulumi import gcp:monitoring/group:Group default {{project}}/{{name}}
Copy
$ pulumi import gcp:monitoring/group:Group default "{{project}} {{name}}"
Copy
$ pulumi import gcp:monitoring/group:Group default {{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.14.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-gcp