View Source AWS.ResourceGroups (aws-elixir v1.0.4)
Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service 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 Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows 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 Resource Groups User Guide.
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 Amazon resource names (ARN)s so they can be returned as search results
* Getting data about resources that are members of a group
* Searching Amazon Web Services resources based on a resource query
Link to this section Summary
Functions
Cancels the specified tag-sync task.
Creates a resource group with the specified name and description.
Deletes the specified resource group.
Retrieves the current status of optional features in Resource Groups.
Returns information about a specified resource group.
Retrieves the service configuration associated with the specified resource group.
Retrieves the resource query associated with the specified resource group.
Returns information about a specified tag-sync task.
Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN).
Adds the specified resources to the specified group.
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group.
Returns the status of the last grouping or ungrouping action for each resource in the specified application group.
Returns a list of existing Resource Groups in your account.
Returns a list of tag-sync tasks.
Attaches a service configuration to the specified group.
Returns a list of Amazon Web Services resource identifiers that matches the specified query.
Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.
Adds tags to a resource group with the specified Amazon resource name (ARN).
Removes the specified resources from the specified group.
Deletes tags from a specified resource group.
Turns on or turns off optional features in Resource Groups.
Updates the description for an existing group.
Updates the resource query of a group.
Link to this section Functions
Cancels the specified tag-sync task.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:CancelTagSyncTask on the application group
*
resource-groups:DeleteGroup
Creates a resource group with the specified name and description.
You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:CreateGroup
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
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:DeleteGroup
Retrieves the current status of optional features in Resource Groups.
Returns information about a specified resource group.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:GetGroup
Retrieves the service configuration associated with the specified resource group.
For details about the service configuration syntax, see Service configurations for Resource Groups.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:GetGroupConfiguration
Retrieves the resource query associated with the specified resource group.
For more information about resource queries, see Create a tag-based group in Resource Groups.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:GetGroupQuery
Returns information about a specified tag-sync task.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:GetTagSyncTask on the application group
Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN).
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:GetTags
Adds the specified resources to the specified group.
You can only use this operation with the following groups:
AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool
AWS::ResourceGroups::ApplicationGroup
Other resource group types and resource types are not currently supported by this operation.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:GroupResources
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:ListGroupResources
*
cloudformation:DescribeStacks
*
cloudformation:ListStackResources
*
tag:GetResources
Returns the status of the last grouping or ungrouping action for each resource in the specified application group.
Returns a list of existing Resource Groups in your account.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:ListGroups
Returns a list of tag-sync tasks.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:ListTagSyncTasks with the group passed in the filters as the
resource
or * if using no filters
Attaches a service configuration to the specified group.
This occurs asynchronously,
and can take time to complete. You can use GetGroupConfiguration to
check the status of the update.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:PutGroupConfiguration
Returns a list of Amazon Web Services 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
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:SearchResources
*
cloudformation:DescribeStacks
*
cloudformation:ListStackResources
*
tag:GetResources
Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:StartTagSyncTask on the application group
*
resource-groups:CreateGroup
*
iam:PassRole on the role provided in the request
Adds tags to a resource group with the specified Amazon resource name (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
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:Tag
Removes the specified resources from the specified group.
This operation works only
with static groups that you populated using the GroupResources
operation. It doesn't work with any resource groups that are automatically
populated by
tag-based or CloudFormation stack-based queries.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:UngroupResources
Deletes tags from a specified resource group.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:Untag
Turns on or turns off optional features in Resource Groups.
The preceding example shows that the request to turn on group lifecycle events
is
IN_PROGRESS. You can call the GetAccountSettings
operation to check for completion by looking for GroupLifecycleEventsStatus
to change to ACTIVE.
Updates the description for an existing group.
You cannot update the name of a resource group.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:UpdateGroup
Updates the resource query of a group.
For more information about resource queries, see Create a tag-based group in Resource Groups.
minimum-permissions
Minimum permissions
To run this command, you must have the following permissions:
*
resource-groups:UpdateGroupQuery