Interface GetResourcesV2Request.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetResourcesV2Request.Builder,GetResourcesV2Request>, SdkBuilder<GetResourcesV2Request.Builder,GetResourcesV2Request>, SdkPojo, SdkRequest.Builder, SecurityHubRequest.Builder
Enclosing class:
GetResourcesV2Request
@Mutable @NotThreadSafe public static interface GetResourcesV2Request.Builder extends SecurityHubRequest.Builder, SdkPojo, CopyableBuilder<GetResourcesV2Request.Builder,GetResourcesV2Request>

  • Method Details

    • filters

      GetResourcesV2Request.Builder filters(ResourcesFilters filters)

      Filters resources based on a set of criteria.

      Parameters:
      filters - Filters resources based on a set of criteria.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default GetResourcesV2Request.Builder filters(Consumer<ResourcesFilters.Builder> filters)

      Filters resources based on a set of criteria.

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

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

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

    • scopes

      GetResourcesV2Request.Builder scopes(ResourceScopes scopes)

      Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator sees resources from all accounts across the entire organization. Other accounts see only their own resources.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

      Parameters:
      scopes - Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator sees resources from all accounts across the entire organization. Other accounts see only their own resources.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

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

    • scopes

      default GetResourcesV2Request.Builder scopes(Consumer<ResourceScopes.Builder> scopes)

      Limits the results to resources from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator sees resources from all accounts across the entire organization. Other accounts see only their own resources.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

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

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

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

    • sortCriteria

      GetResourcesV2Request.Builder sortCriteria(Collection<SortCriterion> sortCriteria)

      The resource attributes used to sort the list of returned resources.

      Parameters:
      sortCriteria - The resource attributes used to sort the list of returned resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortCriteria

      GetResourcesV2Request.Builder sortCriteria(SortCriterion... sortCriteria)

      The resource attributes used to sort the list of returned resources.

      Parameters:
      sortCriteria - The resource attributes used to sort the list of returned resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortCriteria

      GetResourcesV2Request.Builder sortCriteria(Consumer<SortCriterion.Builder>... sortCriteria)

      The resource attributes used to sort the list of returned resources.

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

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

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

    • nextToken

      GetResourcesV2Request.Builder nextToken(String nextToken)

      The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

      Parameters:
      nextToken - The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetResourcesV2Request.Builder maxResults(Integer maxResults)

      The maximum number of results to return.

      Parameters:
      maxResults - The maximum number of results to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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