ResourceQuery - AWS Resource Groups

ResourceQuery

The query that is used to define a resource group or a search for resources.

Contents

Query

The query that defines a group or a search.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: [\s\S]*

Required: Yes

Type

The type of the query. You can use the following values:

  • CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

  • TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API ResourceTypeFilters parameter of the tagging:GetResources operation. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

    For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each:

    [{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]

    The results of this query could include the following.

    • An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}

    • An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}

    The query would not include the following items in the results, however.

    • An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"}.

      The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

    • An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"4"}

      The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^\w+$

Valid Values: TAG_FILTERS_1_0 | CLOUDFORMATION_STACK_1_0

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: