Package software.amazon.awscdk.services.resourcegroups

Class CfnGroup.ResourceQueryProperty.Builder

java.lang.Object
software.amazon.awscdk.services.resourcegroups.CfnGroup.ResourceQueryProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGroup.ResourceQueryProperty>
Enclosing interface:
CfnGroup.ResourceQueryProperty
@Stability(Stable) public static final class CfnGroup.ResourceQueryProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnGroup.ResourceQueryProperty>
A builder for CfnGroup.ResourceQueryProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • query

      @Stability(Stable) public CfnGroup.ResourceQueryProperty.Builder query(IResolvable query)
      Sets the value of CfnGroup.ResourceQueryProperty.getQuery()
      Parameters:
      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.
      Returns:
      this

    • query

      @Stability(Stable) public CfnGroup.ResourceQueryProperty.Builder query(CfnGroup.QueryProperty query)
      Sets the value of CfnGroup.ResourceQueryProperty.getQuery()
      Parameters:
      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.
      Returns:
      this

    • type

      @Stability(Stable) public CfnGroup.ResourceQueryProperty.Builder type(String type)
      Sets the value of CfnGroup.ResourceQueryProperty.getType()
      Parameters:
      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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnGroup.ResourceQueryProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnGroup.ResourceQueryProperty>
      Returns:
      a new instance of CfnGroup.ResourceQueryProperty
      Throws:
      NullPointerException - if any required attribute was not provided