Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResourceGroups

AWS Resource Groups

AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS Config compliance and other monitoring data about member resources.

To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.

For more information about Resource Groups, see the AWS Resource Groups User Guide.

AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

  • Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities

  • Applying, editing, and removing tags from resource groups

  • Resolving resource group member ARNs so they can be returned as search results

  • Getting data about resources that are members of a group

  • Searching AWS resources based on a resource query

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of ResourceGroupsClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

createGroup

deleteGroup

  • Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:DeleteGroup

    Parameters

    Returns Promise<DeleteGroupCommandOutput>

  • Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:DeleteGroup

    Parameters

    Returns void

  • Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:DeleteGroup

    Parameters

    Returns void

  • Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:DeleteGroup

    Parameters

    • args: DeleteGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteGroupCommandOutput>

  • Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:DeleteGroup

    Parameters

    Returns void

  • Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:DeleteGroup

    Parameters

    Returns void

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

getGroup

  • Returns information about a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetGroup

    Parameters

    Returns Promise<GetGroupCommandOutput>

  • Returns information about a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetGroup

    Parameters

    Returns void

  • Returns information about a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetGroup

    Parameters

    Returns void

  • Returns information about a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetGroup

    Parameters

    • args: GetGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetGroupCommandOutput>

  • Returns information about a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetGroup

    Parameters

    Returns void

  • Returns information about a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetGroup

    Parameters

    Returns void

getGroupConfiguration

getGroupQuery

getTags

  • Returns a list of tags that are associated with a resource group, specified by an ARN.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetTags

    Parameters

    Returns Promise<GetTagsCommandOutput>

  • Returns a list of tags that are associated with a resource group, specified by an ARN.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetTags

    Parameters

    Returns void

  • Returns a list of tags that are associated with a resource group, specified by an ARN.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetTags

    Parameters

    Returns void

  • Returns a list of tags that are associated with a resource group, specified by an ARN.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetTags

    Parameters

    • args: GetTagsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetTagsCommandOutput>

  • Returns a list of tags that are associated with a resource group, specified by an ARN.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetTags

    Parameters

    Returns void

  • Returns a list of tags that are associated with a resource group, specified by an ARN.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:GetTags

    Parameters

    Returns void

groupResources

listGroupResources

  • Returns a list of ARNs of the resources that are members of a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroupResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns Promise<ListGroupResourcesCommandOutput>

  • Returns a list of ARNs of the resources that are members of a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroupResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

  • Returns a list of ARNs of the resources that are members of a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroupResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

  • Returns a list of ARNs of the resources that are members of a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroupResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    • args: ListGroupResourcesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListGroupResourcesCommandOutput>

  • Returns a list of ARNs of the resources that are members of a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroupResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

  • Returns a list of ARNs of the resources that are members of a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroupResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

listGroups

  • Returns a list of existing resource groups in your account.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroups

    Parameters

    Returns Promise<ListGroupsCommandOutput>

  • Returns a list of existing resource groups in your account.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroups

    Parameters

    Returns void

  • Returns a list of existing resource groups in your account.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroups

    Parameters

    Returns void

  • Returns a list of existing resource groups in your account.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroups

    Parameters

    • args: ListGroupsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListGroupsCommandOutput>

  • Returns a list of existing resource groups in your account.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroups

    Parameters

    Returns void

  • Returns a list of existing resource groups in your account.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:ListGroups

    Parameters

    Returns void

putGroupConfiguration

searchResources

  • Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:SearchResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns Promise<SearchResourcesCommandOutput>

  • Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:SearchResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

  • Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:SearchResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

  • Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:SearchResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    • args: SearchResourcesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<SearchResourcesCommandOutput>

  • Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:SearchResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

  • Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:SearchResources

    • cloudformation:DescribeStacks

    • cloudformation:ListStackResources

    • tag:GetResources

    Parameters

    Returns void

send

tag

  • Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

    Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Tag

    Parameters

    Returns Promise<TagCommandOutput>

  • Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

    Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Tag

    Parameters

    Returns void

  • Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

    Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Tag

    Parameters

    Returns void

  • Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

    Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Tag

    Parameters

    • args: TagCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<TagCommandOutput>

  • Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

    Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Tag

    Parameters

    Returns void

  • Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

    Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Tag

    Parameters

    Returns void

ungroupResources

untag

  • Deletes tags from a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Untag

    Parameters

    Returns Promise<UntagCommandOutput>

  • Deletes tags from a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Untag

    Parameters

    Returns void

  • Deletes tags from a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Untag

    Parameters

    Returns void

  • Deletes tags from a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Untag

    Parameters

    • args: UntagCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<UntagCommandOutput>

  • Deletes tags from a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Untag

    Parameters

    Returns void

  • Deletes tags from a specified resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:Untag

    Parameters

    Returns void

updateGroup

  • Updates the description for an existing group. You cannot update the name of a resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:UpdateGroup

    Parameters

    Returns Promise<UpdateGroupCommandOutput>

  • Updates the description for an existing group. You cannot update the name of a resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:UpdateGroup

    Parameters

    Returns void

  • Updates the description for an existing group. You cannot update the name of a resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:UpdateGroup

    Parameters

    Returns void

  • Updates the description for an existing group. You cannot update the name of a resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:UpdateGroup

    Parameters

    • args: UpdateGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<UpdateGroupCommandOutput>

  • Updates the description for an existing group. You cannot update the name of a resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:UpdateGroup

    Parameters

    Returns void

  • Updates the description for an existing group. You cannot update the name of a resource group.

    Minimum permissions

    To run this command, you must have the following permissions:

    • resource-groups:UpdateGroup

    Parameters

    Returns void

updateGroupQuery