Group class

Provides a Resource Group.

Example Usage

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

const test = new aws.resourcegroups.Group("test", {
    resourceQuery: {
        query: `{
  \\"ResourceTypeFilters\\": [
    \\"AWS::EC2::Instance\\"
  ],
  \\"TagFilters\\": [
    {
      \\"Key\\": \\"Stage\\",
      \\"Values\\": [\\"Test\\"]
    }
  ]
}
`,
    },
    name: "test-group",
});
import pulumi
import pulumi_aws as aws

test = aws.resourcegroups.Group("test",
    resource_query={
        "query": """{
  \"ResourceTypeFilters\": [
    \"AWS::EC2::Instance\"
  ],
  \"TagFilters\": [
    {
      \"Key\": \"Stage\",
      \"Values\": [\"Test\"]
    }
  ]
}
""",
    },
    name="test-group")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.ResourceGroups.Group("test", new()
    {
        ResourceQuery = new Aws.ResourceGroups.Inputs.GroupResourceQueryArgs
        {
            Query = @"{
  \""ResourceTypeFilters\"": [
    \""AWS::EC2::Instance\""
  ],
  \""TagFilters\"": [
    {
      \""Key\"": \""Stage\"",
      \""Values\"": [\""Test\""]
    }
  ]
}
",
        },
        Name = "test-group",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/resourcegroups"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcegroups.NewGroup(ctx, "test", &resourcegroups.GroupArgs{
			ResourceQuery: &resourcegroups.GroupResourceQueryArgs{
				Query: pulumi.String(`{
  \"ResourceTypeFilters\": [
    \"AWS::EC2::Instance\"
  ],
  \"TagFilters\": [
    {
      \"Key\": \"Stage\",
      \"Values\": [\"Test\"]
    }
  ]
}
`),
			},
			Name: pulumi.String("test-group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_resourcegroups_group" "test" {
  resource_query = {
    query = "{\n  \\\"ResourceTypeFilters\\\": [\n    \\\"AWS::EC2::Instance\\\"\n  ],\n  \\\"TagFilters\\\": [\n    {\n      \\\"Key\\\": \\\"Stage\\\",\n      \\\"Values\\\": [\\\"Test\\\"]\n    }\n  ]\n}\n"
  }
  name = "test-group"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.resourcegroups.Group;
import com.pulumi.aws.resourcegroups.GroupArgs;
import com.pulumi.aws.resourcegroups.inputs.GroupResourceQueryArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 test = new Group("test", GroupArgs.builder()
            .resourceQuery(GroupResourceQueryArgs.builder()
                .query("""
{
  \"ResourceTypeFilters\": [
    \"AWS::EC2::Instance\"
  ],
  \"TagFilters\": [
    {
      \"Key\": \"Stage\",
      \"Values\": [\"Test\"]
    }
  ]
}
                """)
                .build())
            .name("test-group")
            .build());

    }
}
resources:
  test:
    type: aws:resourcegroups:Group
    properties:
      resourceQuery:
        query: |
          {
            \"ResourceTypeFilters\": [
              \"AWS::EC2::Instance\"
            ],
            \"TagFilters\": [
              {
                \"Key\": \"Stage\",
                \"Values\": [\"Test\"]
              }
            ]
          }
      name: test-group

Import

Using pulumi import, import resource groups using the name. For example:

$ pulumi import aws:resourcegroups/group:Group foo resource-group-name

Constructors

Group(String name, {GroupArgs? args, CustomResourceOptions? options})
Creates a new Group. name The Pulumi resource name. args Arguments used to configure this Group. The set of arguments for Group. options Resource options controlling this resource's behavior.
Group.reference(String urn)
Creates a typed reference to an existing Group resource.

Properties

arn ↔ Output<String>
The ARN assigned by AWS for this resource group.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configurations ↔ Output<List<GroupConfiguration>?>
A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. See below for details.
latefinal
description ↔ Output<String?>
A description of the resource group.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The resource group's name. A resource group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with AWS or aws.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceQuery ↔ Output<GroupResourceQuery?>
A resourceQuery block. Resource queries are documented below.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {GroupState? state, CustomResourceOptions? options}) → Group
Gets an existing Group resource's state with the given name and id.