Package software.amazon.awscdk.services.resourcegroups

Interface CfnGroup.ResourceQueryProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGroup.ResourceQueryProperty.Jsii$Proxy

Enclosing class:

CfnGroup

@Stability(Stable)
public static interface CfnGroup.ResourceQueryProperty
extends software.amazon.jsii.JsiiSerializable

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 AWS Resource Groups .

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.*;
 ResourceQueryProperty resourceQueryProperty = ResourceQueryProperty.builder()
         .query(QueryProperty.builder()
                 .resourceTypeFilters(List.of("resourceTypeFilters"))
                 .stackIdentifier("stackIdentifier")
                 .tagFilters(List.of(TagFilterProperty.builder()
                         .key("key")
                         .values(List.of("values"))
                         .build()))
                 .build())
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGroup.ResourceQueryProperty.Builder	A builder for CfnGroup.ResourceQueryProperty
static final class	CfnGroup.ResourceQueryProperty.Jsii$Proxy	An implementation for CfnGroup.ResourceQueryProperty

Method Summary

Modifier and Type	Method	Description
static CfnGroup.ResourceQueryProperty.Builder	builder()
default Object	getQuery()	The query that defines the membership of the group.
default String	getType()	Specifies the type of resource query that determines this group's membership.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getQuery

@Stability(Stable)
@Nullable
default Object getQuery()

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.

getType

@Stability(Stable)
@Nullable
default String getType()

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.

builder

@Stability(Stable)
static CfnGroup.ResourceQueryProperty.Builder builder()

Returns:

a CfnGroup.ResourceQueryProperty.Builder of CfnGroup.ResourceQueryProperty