Client
resourcegroups | R Documentation |
AWS Resource Groups¶
Description¶
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 ARNs 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
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
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¶
svc <- resourcegroups(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
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_account_settings
- Retrieves the current status of optional features in Resource Groups
- get_group
- Returns information about a specified resource group
- get_group_configuration
- Retrieves 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 Amazon Web Services 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_account_settings
- Turns on or turns off optional features in Resource Groups
- update_group
- Updates the description for an existing group
- update_group_query
- Updates the resource query of a group