group_queries

Creates, updates, deletes, gets or lists a group_queries resource.

Overview

Name	group_queries
Type	Resource
Id	aws.resource_groups.group_queries

Fields

The following fields are returned by SELECT queries:

get_group_query

Name	Datatype	Description
group_name	string	The name of the resource group that is associated with the specified resource query. (pattern: <code>[a-zA-Z0-9_.-]{1,300}|[a-zA-Z0-9_.-]{1,150}/[a-z0-9]{26}</code>)
resource_query	object	The query you can use to define a resource group or a search for resources. A ResourceQuery specifies both a query Type and a Query string as JSON string objects. See the examples section for example JSON strings. For more information about creating a resource group with a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide When you combine all of the elements together into a single string, any double quotes that are embedded inside another double quote pair must be escaped by preceding the embedded double quote with a backslash character (). For example, a complete ResourceQuery parameter must be formatted like the following CLI parameter example: --resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{"ResourceTypeFilters":["AWS::AllSupported"],"TagFilters":[{"Key":"Stage","Values":["Test"]}]}"}' In the preceding example, all of the double quote characters in the value part of the Query element must be escaped because the value itself is surrounded by double quotes. For more information, see Quoting strings in the Command Line Interface User Guide. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide. For example: "ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group_query	select	region		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 To run this command, you must have the following permissions: resource-groups:GetGroupQuery
update_group_query	update	region, ResourceQuery		Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroupQuery

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_group_query

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 To run this command, you must have the following permissions: resource-groups:GetGroupQuery

SELECT
group_name,
resource_query
FROM aws.resource_groups.group_queries
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_group_query

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroupQuery

UPDATE aws.resource_groups.group_queries
SET 
GroupName = '{{ GroupName }}',
Group = '{{ Group }}',
ResourceQuery = '{{ ResourceQuery }}'
WHERE 
region = '{{ region }}' --required
AND ResourceQuery = '{{ ResourceQuery }}' --required
RETURNING
group_query;