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

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);

def Group(resource_name, opts=None, display_name=None, filter=None, is_cluster=None, parent_name=None, project=None, __props__=None);

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

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

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Group Resource Properties

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

Inputs

The Group resource accepts the following input properties:

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.
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 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.
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 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.
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 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.
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 str: 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 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}“.

Look up an 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

static get(resource_name, id, opts=None, display_name=None, filter=None, is_cluster=None, name=None, parent_name=None, project=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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 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 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 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 str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud