Interface CfnGroup.TagFilterProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGroup.TagFilterProperty.Jsii$Proxy
- Enclosing class:
CfnGroup
An AWS 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 eitherTest
orBeta
Storage
tag key with any value
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.resourcegroups.*; TagFilterProperty tagFilterProperty = TagFilterProperty.builder() .key("key") .values(List.of("values")) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGroup.TagFilterProperty
static final class
An implementation forCfnGroup.TagFilterProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getKey
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'sType
property isTAG_FILTERS_1_0
. You must specify at least one tag key.- See Also:
-
getValues
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 AWS resource with any value for that key is a member.
- See Also:
-
builder
- Returns:
- a
CfnGroup.TagFilterProperty.Builder
ofCfnGroup.TagFilterProperty
-