Class 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
• How-to Guides
• Official Documentation

Example Usage - Monitoring Group Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var basic = new Gcp.Monitoring.Group("basic", new Gcp.Monitoring.GroupArgs
    {
        DisplayName = "tf-test MonitoringGroup",
        Filter = "resource.metadata.region=\"europe-west2\"",
    });
}

}

Example Usage - Monitoring Group Subgroup

using Pulumi;
using Gcp = Pulumi.Gcp;

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

}

Inheritance

System.Object

Resource

CustomResource

Group

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Monitoring

Assembly: Pulumi.Gcp.dll

Syntax

public class Group : CustomResource

Constructors

Group(String, GroupArgs, CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

Declaration

public Group(string name, GroupArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

DisplayName

A user-assigned name for this group, used only for display purposes.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

Filter

The filter used to determine which monitored resources belong to this group.

Declaration

public Output<string> Filter { get; }

Property Value

Type	Description
Output<System.String>

IsCluster

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

Declaration

public Output<bool?> IsCluster { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Name

A unique identifier for this group. The format is "projects/{project_id_or_number}/groups/{group_id}".

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ParentName

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, "".

Declaration

public Output<string> ParentName { get; }

Property Value

Type	Description
Output<System.String>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, GroupState, CustomResourceOptions)

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

Declaration

public static Group Get(string name, Input<string> id, GroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Group