Package software.amazon.awssdk.services.cloudformation.model

Interface DeleteStackInstancesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>, SdkBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DeleteStackInstancesRequest

@Mutable
@NotThreadSafe
public static interface DeleteStackInstancesRequest.Builder
extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>

Method Summary

Modifier and Type	Method	Description
DeleteStackInstancesRequest.Builder	accounts(String... accounts)	[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.
DeleteStackInstancesRequest.Builder	accounts(Collection<String> accounts)	[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.
DeleteStackInstancesRequest.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.
DeleteStackInstancesRequest.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.
default DeleteStackInstancesRequest.Builder	deploymentTargets(Consumer<DeploymentTargets.Builder> deploymentTargets)	[Service-managed permissions] The Organizations accounts from which to delete stack instances.
DeleteStackInstancesRequest.Builder	deploymentTargets(DeploymentTargets deploymentTargets)	[Service-managed permissions] The Organizations accounts from which to delete stack instances.
DeleteStackInstancesRequest.Builder	operationId(String operationId)	The unique identifier for this StackSet operation.
default DeleteStackInstancesRequest.Builder	operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)	Preferences for how CloudFormation performs this StackSet operation.
DeleteStackInstancesRequest.Builder	operationPreferences(StackSetOperationPreferences operationPreferences)	Preferences for how CloudFormation performs this StackSet operation.
DeleteStackInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DeleteStackInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DeleteStackInstancesRequest.Builder	regions(String... regions)	The Amazon Web Services Regions where you want to delete StackSet instances.
DeleteStackInstancesRequest.Builder	regions(Collection<String> regions)	The Amazon Web Services Regions where you want to delete StackSet instances.
DeleteStackInstancesRequest.Builder	retainStacks(Boolean retainStacks)	Removes the stack instances from the specified StackSet, but doesn't delete the stacks.
DeleteStackInstancesRequest.Builder	stackSetName(String stackSetName)	The name or unique ID of the StackSet that you want to delete 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, sdkFieldNameToField, sdkFields

Method Detail

stackSetName

DeleteStackInstancesRequest.Builder stackSetName(String stackSetName)

The name or unique ID of the StackSet that you want to delete stack instances for.

Parameters:

stackSetName - The name or unique ID of the StackSet that you want to delete stack instances for.

Returns:

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

accounts

DeleteStackInstancesRequest.Builder accounts(Collection<String> accounts)

[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

Parameters:

accounts - [Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

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

accounts

DeleteStackInstancesRequest.Builder accounts(String... accounts)

[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

Parameters:

accounts - [Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

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

deploymentTargets

DeleteStackInstancesRequest.Builder deploymentTargets(DeploymentTargets deploymentTargets)

[Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

Parameters:

deploymentTargets - [Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

Returns:

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

deploymentTargets

default DeleteStackInstancesRequest.Builder deploymentTargets(Consumer<DeploymentTargets.Builder> deploymentTargets)

[Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

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

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

Parameters:

deploymentTargets - a consumer that will call methods on DeploymentTargets.Builder

Returns:

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

See Also:

deploymentTargets(DeploymentTargets)

regions

DeleteStackInstancesRequest.Builder regions(Collection<String> regions)

The Amazon Web Services Regions where you want to delete StackSet instances.

Parameters:

regions - The Amazon Web Services Regions where you want to delete StackSet instances.

Returns:

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

regions

DeleteStackInstancesRequest.Builder regions(String... regions)

The Amazon Web Services Regions where you want to delete StackSet instances.

Parameters:

regions - The Amazon Web Services Regions where you want to delete StackSet instances.

Returns:

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

operationPreferences

DeleteStackInstancesRequest.Builder operationPreferences(StackSetOperationPreferences operationPreferences)

Preferences for how CloudFormation performs this StackSet operation.

Parameters:

operationPreferences - Preferences for how CloudFormation performs this StackSet operation.

Returns:

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

operationPreferences

default DeleteStackInstancesRequest.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)

Preferences for how CloudFormation performs this StackSet operation.

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

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

Parameters:

operationPreferences - a consumer that will call methods on StackSetOperationPreferences.Builder

Returns:

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

See Also:

operationPreferences(StackSetOperationPreferences)

retainStacks

DeleteStackInstancesRequest.Builder retainStacks(Boolean retainStacks)

Removes the stack instances from the specified StackSet, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see StackSet operation options.

Parameters:

retainStacks - Removes the stack instances from the specified StackSet, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see StackSet operation options.

Returns:

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

operationId

DeleteStackInstancesRequest.Builder operationId(String operationId)

The unique identifier for this StackSet operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.

Repeating this StackSet operation with a new operation ID retries all stack instances whose status is OUTDATED.

Parameters:

operationId - The unique identifier for this StackSet operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.

Repeating this StackSet operation with a new operation ID retries all stack instances whose status is OUTDATED.

Returns:

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

callAs

DeleteStackInstancesRequest.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 StackSets 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 StackSets 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, CallAs

callAs

DeleteStackInstancesRequest.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 StackSets 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 StackSets 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, CallAs

overrideConfiguration

DeleteStackInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DeleteStackInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder