resourcegroups: AWS Resource Groups

Description Usage Arguments Value Service syntax Operations Examples

View source: R/resourcegroups_service.R

Description

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.

Usage

1
resourcegroups(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- resourcegroups(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_group Creates a resource group with the specified name and description
delete_group Deletes the specified resource group
get_group Returns information about a specified resource group
get_group_configuration Returns the service configuration associated with the specified resource group
get_group_query Retrieves the resource query associated with the specified resource group
get_tags Returns a list of tags that are associated with a resource group, specified by an ARN
group_resources Adds the specified resources to the specified group
list_group_resources Returns a list of ARNs of the resources that are members of a specified resource group
list_groups Returns a list of existing resource groups in your account
put_group_configuration Attaches a service configuration to the specified group
search_resources Returns a list of AWS resource identifiers that matches the specified query
tag Adds tags to a resource group with the specified ARN
ungroup_resources Removes the specified resources from the specified group
untag Deletes tags from a specified resource group
update_group Updates the description for an existing group
update_group_query Updates the resource query of a group

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- resourcegroups()
svc$create_group(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.