Package com.pulumi.aws.resourcegroups

Class Group

  • public class Group
extends com.pulumi.resources.CustomResource
    Provides a Resource Group. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import resource groups using the `name`. For example: ```sh $ pulumi import aws:resourcegroups/group:Group foo resource-group-name ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Group​(java.lang.String name)  
      Group​(java.lang.String name, GroupArgs args)  
      Group​(java.lang.String name, GroupArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<GroupConfiguration>>> configurations()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Group get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<GroupResourceQuery>> resourceQuery()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Group

        public Group​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Group

        public Group​(java.lang.String name,
             @Nullable
             GroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Group

        public Group​(java.lang.String name,
             @Nullable
             GroupArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN assigned by AWS for this resource group.

      • configurations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<GroupConfiguration>>> configurations()
        Returns:
        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.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        A description of the resource group.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        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`.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • resourceQuery

        public com.pulumi.core.Output<java.util.Optional<GroupResourceQuery>> resourceQuery()
        Returns:
        A `resourceQuery` block. Resource queries are documented below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Group get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        GroupState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.