Interface CreateGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>, ResourceGroupsRequest.Builder, SdkBuilder<CreateGroupRequest.Builder,CreateGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGroupRequest

public static interface CreateGroupRequest.Builder extends ResourceGroupsRequest.Builder, SdkPojo, CopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>
  • Method Details

    • name

      The name of the group, which is the identifier of the group in other operations. You can't change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with AWS or aws; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account.

      Parameters:
      name - The name of the group, which is the identifier of the group in other operations. You can't change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with AWS or aws; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      CreateGroupRequest.Builder description(String description)

      The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.

      Parameters:
      description - The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceQuery

      CreateGroupRequest.Builder resourceQuery(ResourceQuery resourceQuery)

      The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups.

      A resource group can contain either a ResourceQuery or a Configuration, but not both.

      Parameters:
      resourceQuery - The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups.

      A resource group can contain either a ResourceQuery or a Configuration, but not both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceQuery

      default CreateGroupRequest.Builder resourceQuery(Consumer<ResourceQuery.Builder> resourceQuery)

      The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups.

      A resource group can contain either a ResourceQuery or a Configuration, but not both.

      This is a convenience method that creates an instance of the ResourceQuery.Builder avoiding the need to create one manually via ResourceQuery.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceQuery(ResourceQuery).

      Parameters:
      resourceQuery - a consumer that will call methods on ResourceQuery.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • tags

      The tags to add to the group. A tag is key-value pair string.

      Parameters:
      tags - The tags to add to the group. A tag is key-value pair string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • configuration

      A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.

      A resource group can contain either a Configuration or a ResourceQuery, but not both.

      Parameters:
      configuration - A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.

      A resource group can contain either a Configuration or a ResourceQuery, but not both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • configuration

      CreateGroupRequest.Builder configuration(GroupConfigurationItem... configuration)

      A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.

      A resource group can contain either a Configuration or a ResourceQuery, but not both.

      Parameters:
      configuration - A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.

      A resource group can contain either a Configuration or a ResourceQuery, but not both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • configuration

      A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.

      A resource group can contain either a Configuration or a ResourceQuery, but not both.

      This is a convenience method that creates an instance of the GroupConfigurationItem.Builder avoiding the need to create one manually via GroupConfigurationItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(List<GroupConfigurationItem>).

      Parameters:
      configuration - a consumer that will call methods on GroupConfigurationItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.