software.amazon.awscdk.services.resourcegroups

Interface CfnGroup.QueryProperty

All Known Implementing Classes:

CfnGroup.QueryProperty.Jsii$Proxy

Enclosing class:

CfnGroup

public static interface CfnGroup.QueryProperty

Specifies details within a `ResourceQuery` structure that determines the membership of the resource group.

The contents required in the Query structure are determined by the Type property of the containing ResourceQuery structure.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGroup.QueryProperty.Builder	builder()
default java.util.List<java.lang.String>	getResourceTypeFilters() Specifies limits to the types of resources that can be included in the resource group.
default java.lang.String	getStackIdentifier() Specifies the ARN of a CloudFormation stack.
default java.lang.Object	getTagFilters() A list of key-value pair objects that limit which resources can be members of the resource group.

Method Detail

getResourceTypeFilters

default java.util.List<java.lang.String> getResourceTypeFilters()

Specifies limits to the types of resources that can be included in the resource group.

For example, if ResourceTypeFilters is ["AWS::EC2::Instance", "AWS::DynamoDB::Table"] , only EC2 instances or DynamoDB tables can be members of this resource group. The default value is ["AWS::AllSupported"] .

getStackIdentifier

default java.lang.String getStackIdentifier()

Specifies the ARN of a CloudFormation stack.

All supported resources of the CloudFormation stack are members of the resource group. If you don't specify an ARN, this parameter defaults to the current stack that you are defining, which means that all the resources of the current stack are grouped.

You can specify a value for StackIdentifier only when the ResourceQuery.Type property is CLOUDFORMATION_STACK_1_0.

getTagFilters

default java.lang.Object getTagFilters()

A list of key-value pair objects that limit which resources can be members of the resource group.

This property is required when the ResourceQuery.Type property is TAG_FILTERS_1_0 .

A resource must have a tag that matches every filter that is provided in the TagFilters list.

builder

static CfnGroup.QueryProperty.Builder builder()

Returns:

a CfnGroup.QueryProperty.Builder of CfnGroup.QueryProperty