software.amazon.awssdk.services.cloudformation.model

Class DeleteStackInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.DeleteStackInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DeleteStackInstancesRequest
extends CloudFormationRequest
implements ToCopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteStackInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	accounts() The names of the AWS accounts that you want to delete stack instances for.
static DeleteStackInstancesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	operationId() The unique identifier for this stack set operation.
StackSetOperationPreferences	operationPreferences() Preferences for how AWS CloudFormation performs this stack set operation.
List<String>	regions() The regions where you want to delete stack set instances.
Boolean	retainStacks() Removes the stack instances from the specified stack set, but doesn't delete the stacks.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteStackInstancesRequest.Builder>	serializableBuilderClass()
String	stackSetName() The name or unique ID of the stack set that you want to delete stack instances for.
DeleteStackInstancesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

stackSetName

public String stackSetName()

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

Returns:

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

accounts

public List<String> accounts()

The names of the AWS accounts that you want to delete stack instances for.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The names of the AWS accounts that you want to delete stack instances for.

regions

public List<String> regions()

The regions where you want to delete stack set instances.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The regions where you want to delete stack set instances.

operationPreferences

public StackSetOperationPreferences operationPreferences()

Preferences for how AWS CloudFormation performs this stack set operation.

Returns:

Preferences for how AWS CloudFormation performs this stack set operation.

retainStacks

public Boolean retainStacks()

Removes the stack instances from the specified stack set, 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 Stack set operation options.

Returns:

Removes the stack instances from the specified stack set, 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 Stack set operation options.

operationId

public String operationId()

The unique identifier for this stack set 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 AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

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

Returns:

The unique identifier for this stack set 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 AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

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

toBuilder

public DeleteStackInstancesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>

Specified by:

toBuilder in class CloudFormationRequest

Returns:

a builder for type T

builder

public static DeleteStackInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteStackInstancesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.