Interface ListStackInstancesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudFormationRequest.Builder
,CopyableBuilder<ListStackInstancesRequest.Builder,
,ListStackInstancesRequest> SdkBuilder<ListStackInstancesRequest.Builder,
,ListStackInstancesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListStackInstancesRequest
-
Method Summary
Modifier and TypeMethodDescription[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.[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.filters
(Collection<StackInstanceFilter> filters) The filter to apply to stack instancesfilters
(Consumer<StackInstanceFilter.Builder>... filters) The filter to apply to stack instancesfilters
(StackInstanceFilter... filters) The filter to apply to stack instancesmaxResults
(Integer maxResults) The maximum number of results to be returned with a single call.If the previous request didn't return all the remaining results, the response'sNextToken
parameter value is set to a token.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.stackInstanceAccount
(String stackInstanceAccount) The name of the Amazon Web Services account that you want to list stack instances for.stackInstanceRegion
(String stackInstanceRegion) The name of the Region where you want to list stack instances.stackSetName
(String stackSetName) The name or unique ID of the stack set that you want to list stack instances for.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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, callListStackInstances
again and assign that token to the request object'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.- Parameters:
nextToken
- If the previous request didn't return all the remaining results, the response'sNextToken
parameter value is set to a token. To retrieve the next set of results, callListStackInstances
again and assign that token to the request object'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theNextToken
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 aNextToken
value that you can assign to theNextToken
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
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
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
The filter to apply to stack instances
This is a convenience method that creates an instance of theStackInstanceFilter.Builder
avoiding the need to create one manually viaStackInstanceFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<StackInstanceFilter>)
.- Parameters:
filters
- a consumer that will call methods onStackInstanceFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
[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. UseSELF
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. UseSELF
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
[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. UseSELF
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. UseSELF
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-