Package software.amazon.awssdk.services.resourcegroupstaggingapi.model

Interface GetComplianceSummaryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetComplianceSummaryRequest.Builder,GetComplianceSummaryRequest>, ResourceGroupsTaggingApiRequest.Builder, SdkBuilder<GetComplianceSummaryRequest.Builder,GetComplianceSummaryRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetComplianceSummaryRequest
public static interface GetComplianceSummaryRequest.Builder extends ResourceGroupsTaggingApiRequest.Builder, SdkPojo, CopyableBuilder<GetComplianceSummaryRequest.Builder,GetComplianceSummaryRequest>

  • Method Details

    • targetIdFilters

      GetComplianceSummaryRequest.Builder targetIdFilters(Collection<String> targetIdFilters)

      Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

      Parameters:
      targetIdFilters - Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetIdFilters

      GetComplianceSummaryRequest.Builder targetIdFilters(String... targetIdFilters)

      Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

      Parameters:
      targetIdFilters - Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regionFilters

      GetComplianceSummaryRequest.Builder regionFilters(Collection<String> regionFilters)

      Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

      Parameters:
      regionFilters - Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regionFilters

      GetComplianceSummaryRequest.Builder regionFilters(String... regionFilters)

      Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

      Parameters:
      regionFilters - Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceTypeFilters

      GetComplianceSummaryRequest.Builder resourceTypeFilters(Collection<String> resourceTypeFilters)

      Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

      The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:

      You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

      Parameters:
      resourceTypeFilters - Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

      The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:

      You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

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

    • resourceTypeFilters

      GetComplianceSummaryRequest.Builder resourceTypeFilters(String... resourceTypeFilters)

      Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

      The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:

      You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

      Parameters:
      resourceTypeFilters - Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

      The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:

      You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

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

    • tagKeyFilters

      GetComplianceSummaryRequest.Builder tagKeyFilters(Collection<String> tagKeyFilters)

      Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

      Parameters:
      tagKeyFilters - Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagKeyFilters

      GetComplianceSummaryRequest.Builder tagKeyFilters(String... tagKeyFilters)

      Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

      Parameters:
      tagKeyFilters - Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupByWithStrings

      GetComplianceSummaryRequest.Builder groupByWithStrings(Collection<String> groupBy)

      Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

      Parameters:
      groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupByWithStrings

      GetComplianceSummaryRequest.Builder groupByWithStrings(String... groupBy)

      Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

      Parameters:
      groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      GetComplianceSummaryRequest.Builder groupBy(Collection<GroupByAttribute> groupBy)

      Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

      Parameters:
      groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      GetComplianceSummaryRequest.Builder groupBy(GroupByAttribute... groupBy)

      Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

      Parameters:
      groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetComplianceSummaryRequest.Builder maxResults(Integer maxResults)

      Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

      Parameters:
      maxResults - Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • paginationToken

      GetComplianceSummaryRequest.Builder paginationToken(String paginationToken)

      Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

      Parameters:
      paginationToken - Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetComplianceSummaryRequest.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

      GetComplianceSummaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.