ResourceGroups class

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.

Constructors

ResourceGroups({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createGroup({required String name, List<GroupConfigurationItem>? configuration, String? description, ResourceQuery? resourceQuery, Map<String, String>? tags}) → Future<CreateGroupOutput>

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups. For more information about service configurations, see Service configurations for resource groups.

deleteGroup({String? group, String? groupName}) → Future<DeleteGroupOutput>

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.

getGroup({String? group, String? groupName}) → Future<GetGroupOutput>

Returns information about a specified resource group.

getGroupConfiguration({String? group}) → Future<GetGroupConfigurationOutput>

Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups.

getGroupQuery({String? group, String? groupName}) → Future<GetGroupQueryOutput>

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.

getTags({required String arn}) → Future<GetTagsOutput>

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

groupResources({required String group, required List<String> resourceArns}) → Future<GroupResourcesOutput>

Adds the specified resources to the specified group.

listGroupResources({List<ResourceFilter>? filters, String? group, String? groupName, int? maxResults, String? nextToken}) → Future<ListGroupResourcesOutput>

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

listGroups({List<GroupFilter>? filters, int? maxResults, String? nextToken}) → Future<ListGroupsOutput>

Returns a list of existing resource groups in your account.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putGroupConfiguration({List<GroupConfigurationItem>? configuration, String? group}) → Future<void>

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.

searchResources({required ResourceQuery resourceQuery, int? maxResults, String? nextToken}) → Future<SearchResourcesOutput>

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.

tag({required String arn, required Map<String, String> tags}) → Future<TagOutput>

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. Minimum permissions

toString() → String

A string representation of this object.

inherited

ungroupResources({required String group, required List<String> resourceArns}) → Future<UngroupResourcesOutput>

Removes the specified resources from the specified group.

untag({required String arn, required List<String> keys}) → Future<UntagOutput>

Deletes tags from a specified resource group.

updateGroup({String? description, String? group, String? groupName}) → Future<UpdateGroupOutput>

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

updateGroupQuery({required ResourceQuery resourceQuery, String? group, String? groupName}) → Future<UpdateGroupQueryOutput>

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Operators

operator ==(Object other) → bool

The equality operator.

inherited