Interface ListStackInstancesRequest.Builder

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

  • Method Details

    • stackSetName

      ListStackInstancesRequest.Builder stackSetName(String stackSetName)

      The name or unique ID of the stack set that you want to list stack instances for.

      Parameters:
      stackSetName - The name or unique ID of the stack set that you want to list stack instances for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListStackInstancesRequest.Builder nextToken(String nextToken)

      If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

      Parameters:
      nextToken - If the previous request didn't return all the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListStackInstancesRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

      Parameters:
      maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListStackInstancesRequest.Builder filters(Collection<StackInstanceFilter> filters)

      The filter to apply to stack instances

      Parameters:
      filters - The filter to apply to stack instances
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListStackInstancesRequest.Builder filters(StackInstanceFilter... filters)

      The filter to apply to stack instances

      Parameters:
      filters - The filter to apply to stack instances
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ListStackInstancesRequest.Builder filters(Consumer<StackInstanceFilter.Builder>... filters)

      The filter to apply to stack instances

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

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

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

    • stackInstanceAccount

      ListStackInstancesRequest.Builder stackInstanceAccount(String stackInstanceAccount)

      The name of the Amazon Web Services account that you want to list stack instances for.

      Parameters:
      stackInstanceAccount - The name of the Amazon Web Services account that you want to list stack instances for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackInstanceRegion

      ListStackInstancesRequest.Builder stackInstanceRegion(String stackInstanceRegion)

      The name of the Region where you want to list stack instances.

      Parameters:
      stackInstanceRegion - The name of the Region where you want to list stack instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • callAs

      ListStackInstancesRequest.Builder callAs(String callAs)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Parameters:
      callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

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

    • callAs

      ListStackInstancesRequest.Builder callAs(CallAs callAs)

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      Parameters:
      callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

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

    • overrideConfiguration

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

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