AWS::ResourceGroups::Group ResourceQuery - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ResourceGroups::Group ResourceQuery

The query used to dynamically define the members of a group. For more information about how to construct a query, see Build queries and groups in Amazon Resource Groups.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Query" : Query,
  "Type" : String
}

YAML

  Query: 
    Query
  Type: String

Properties

Query

The query that defines the membership of the group. This is a structure with properties that depend on the Type.

The Query structure must be included in the following scenarios:

  • When the Type is TAG_FILTERS_1_0, you must specify a Query structure that contains a TagFilters list of tags. Resources with tags that match those in the TagFilter list become members of the resource group.

  • When the Type is CLOUDFORMATION_STACK_1_0 then this field is required only when you must specify a CloudFormation stack other than the one you are defining. To do this, the Query structure must contain the StackIdentifier property. If you don't specify either a Query structure or a StackIdentifier within that Query, then it defaults to the CloudFormation stack that you're currently constructing.

Required: No

Type: Query

Pattern: [\s\S]*

Maximum: 4096

Update requires: No interruption

Type

Specifies the type of resource query that determines this group's membership. There are two valid query types:

  • TAG_FILTERS_1_0 indicates that the group is a tag-based group. To complete the group membership, you must include the TagFilters property to specify the tag filters to use in the query.

  • CLOUDFORMATION_STACK_1_0, the default, indicates that the group is a CloudFormation stack-based group. Group membership is based on the CloudFormation stack. You must specify the StackIdentifier property in the query to define which stack to associate the group with, or leave it empty to default to the stack where the group is defined.

Required: No

Type: String

Allowed values: TAG_FILTERS_1_0 | CLOUDFORMATION_STACK_1_0

Update requires: No interruption