Package software.amazon.awscdk.services.resourcegroups

Class CfnGroupProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnGroupProps.Builder name(String name)
      Sets the value of CfnGroupProps.getName()
      Parameters:
      name - The name of a resource group. This parameter is required. The name must be unique within the AWS Region in which you create the resource. To create multiple resource groups based on the same CloudFormation stack, you must generate unique names for each.
      Returns:
      this

    • configuration

      @Stability(Stable) public CfnGroupProps.Builder configuration(IResolvable configuration)
      Sets the value of CfnGroupProps.getConfiguration()
      Parameters:
      configuration - The service configuration currently associated with the resource group and in effect for the members of the resource group. A Configuration consists of one or more ConfigurationItem entries. For information about service configurations for resource groups and how to construct them, see Service configurations for resource groups in the AWS Resource Groups User Guide .

      You can include either a Configuration or a ResourceQuery , but not both.

      Returns:
      this

    • configuration

      @Stability(Stable) public CfnGroupProps.Builder configuration(List<? extends Object> configuration)
      Sets the value of CfnGroupProps.getConfiguration()
      Parameters:
      configuration - The service configuration currently associated with the resource group and in effect for the members of the resource group. A Configuration consists of one or more ConfigurationItem entries. For information about service configurations for resource groups and how to construct them, see Service configurations for resource groups in the AWS Resource Groups User Guide .

      You can include either a Configuration or a ResourceQuery , but not both.

      Returns:
      this

    • description

      @Stability(Stable) public CfnGroupProps.Builder description(String description)
      Sets the value of CfnGroupProps.getDescription()
      Parameters:
      description - The description of the resource group.
      Returns:
      this

    • resourceQuery

      @Stability(Stable) public CfnGroupProps.Builder resourceQuery(IResolvable resourceQuery)
      Sets the value of CfnGroupProps.getResourceQuery()
      Parameters:
      resourceQuery - The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. For more information about queries and how to construct them, see Build queries and groups in AWS Resource Groups in the AWS Resource Groups User Guide

      • You can include either a ResourceQuery or a Configuration , but not both.
      • You can specify the group's membership either by using a ResourceQuery or by using a list of Resources , but not both.

      Returns:
      this

    • resourceQuery

      @Stability(Stable) public CfnGroupProps.Builder resourceQuery(CfnGroup.ResourceQueryProperty resourceQuery)
      Sets the value of CfnGroupProps.getResourceQuery()
      Parameters:
      resourceQuery - The resource query structure that is used to dynamically determine which AWS resources are members of the associated resource group. For more information about queries and how to construct them, see Build queries and groups in AWS Resource Groups in the AWS Resource Groups User Guide

      • You can include either a ResourceQuery or a Configuration , but not both.
      • You can specify the group's membership either by using a ResourceQuery or by using a list of Resources , but not both.

      Returns:
      this

    • resources

      @Stability(Stable) public CfnGroupProps.Builder resources(List<String> resources)
      Sets the value of CfnGroupProps.getResources()
      Parameters:
      resources - A list of the Amazon Resource Names (ARNs) of AWS resources that you want to add to the specified group.

      • You can specify the group membership either by using a list of Resources or by using a ResourceQuery , but not both.
      • You can include a Resources property only if you also specify a Configuration property.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnGroupProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnGroupProps.getTags()
      Parameters:
      tags - The tag key and value pairs that are attached to the resource group.
      Returns:
      this

    • build

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