[−][src]Crate rusoto_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
If you're using the service, you're probably looking for ResourceGroupsClient and ResourceGroups.
Structs
CreateGroupInput | |
CreateGroupOutput | |
DeleteGroupInput | |
DeleteGroupOutput | |
FailedResource | A resource that failed to be added to or removed from a group. |
GetGroupConfigurationInput | |
GetGroupConfigurationOutput | |
GetGroupInput | |
GetGroupOutput | |
GetGroupQueryInput | |
GetGroupQueryOutput | |
GetTagsInput | |
GetTagsOutput | |
Group | A resource group that contains AWS resources. You can assign resources to the group by associating either of the following elements with the group:
|
GroupConfiguration | A service configuration associated with a resource group. The configuration options are determined by the AWS service that defines the |
GroupConfigurationItem | An item in a group configuration. A group configuration can have one or more items. |
GroupConfigurationParameter | A parameter for a group configuration item. |
GroupFilter | A filter collection that you can use to restrict the results from a |
GroupIdentifier | The unique identifiers for a resource group. |
GroupQuery | A mapping of a query attached to a resource group that determines the AWS resources that are members of the group. |
GroupResourcesInput | |
GroupResourcesOutput | |
ListGroupResourcesInput | |
ListGroupResourcesOutput | |
ListGroupsInput | |
ListGroupsOutput | |
QueryError | A two-part error structure that can occur in |
ResourceFilter | A filter name and value pair that is used to obtain more specific results from a list of resources. |
ResourceGroupsClient | A client for the Resource Groups API. |
ResourceIdentifier | The ARN of a resource, and its resource type. |
ResourceQuery | The query that is used to define a resource group or a search for resources. A query specifies both a query type and a query string as a JSON object. See the examples section for example JSON strings. The examples that follow are shown as standard JSON strings. If you include such a string as a parameter to the AWS CLI or an SDK API, you might need to 'escape' the string into a single line. For example, see the Quoting strings in the AWS CLI User Guide. Example 1 The following generic example shows a resource query JSON string that includes only resources that meet the following criteria:
This has the equivalent "shortcut" syntax of the following: Example 2 The following example shows a resource query JSON string that includes only Amazon EC2 instances that are tagged Example 3 The following example shows a resource query JSON string that includes resource of any supported type as long as it is tagged Example 4 The following example shows a resource query JSON string that includes only Amazon EC2 instances and Amazon S3 buckets that are part of the specified AWS CloudFormation stack. |
SearchResourcesInput | |
SearchResourcesOutput | |
TagInput | |
TagOutput | |
UngroupResourcesInput | |
UngroupResourcesOutput | |
UntagInput | |
UntagOutput | |
UpdateGroupInput | |
UpdateGroupOutput | |
UpdateGroupQueryInput | |
UpdateGroupQueryOutput |
Enums
CreateGroupError | Errors returned by CreateGroup |
DeleteGroupError | Errors returned by DeleteGroup |
GetGroupConfigurationError | Errors returned by GetGroupConfiguration |
GetGroupError | Errors returned by GetGroup |
GetGroupQueryError | Errors returned by GetGroupQuery |
GetTagsError | Errors returned by GetTags |
GroupResourcesError | Errors returned by GroupResources |
ListGroupResourcesError | Errors returned by ListGroupResources |
ListGroupsError | Errors returned by ListGroups |
SearchResourcesError | Errors returned by SearchResources |
TagError | Errors returned by Tag |
UngroupResourcesError | Errors returned by UngroupResources |
UntagError | Errors returned by Untag |
UpdateGroupError | Errors returned by UpdateGroup |
UpdateGroupQueryError | Errors returned by UpdateGroupQuery |
Traits
ResourceGroups | Trait representing the capabilities of the Resource Groups API. Resource Groups clients implement this trait. |