AWS::ResourceGroups::Group TagFilter - 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).

AWS::ResourceGroups::Group TagFilter

Specifies a single tag key and optional values that you can use to specify membership in a tag-based group. An Amazon resource that doesn't have a matching tag key and value is rejected as a member of the group.

A TagFilter object includes two properties: Key (a string) and Values (a list of strings). Only resources in the account that are tagged with a matching key-value pair are members of the group. The Values property of TagFilter is optional, but specifying it narrows the query results.

As an example, suppose the TagFilters string is [{"Key": "Stage", "Values": ["Test", "Beta"]}, {"Key": "Storage"}]. In this case, only resources with all of the following tags are members of the group:

  • Stage tag key with a value of either Test or Beta

  • Storage tag key with any value

Syntax

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

JSON

{
  "Key" : String,
  "Values" : [ String, ... ]
}

YAML

  Key: String
  Values: 
    - String

Properties

Key

A string that defines a tag key. Only resources in the account that are tagged with a specified tag key are members of the tag-based resource group.

This field is required when the ResourceQuery structure's Type property is TAG_FILTERS_1_0. You must specify at least one tag key.

Required: Conditional

Type: String

Update requires: No interruption

Values

A list of tag values that can be included in the tag-based resource group. This is optional. If you don't specify a value or values for a key, then an Amazon resource with any value for that key is a member.

Required: No

Type: Array of String

Update requires: No interruption