DeleteStackInstancesRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DeleteStackInstancesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`accounts()` [`Self-managed` permissions] The names of the AWS accounts that you want to delete stack instances for.
`static DeleteStackInstancesRequest.Builder`	`builder()`
`DeploymentTargets`	`deploymentTargets()` [`Service-managed` permissions] The AWS Organizations accounts from which to delete stack instances.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccounts()` Returns true if the Accounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRegions()` Returns true if the Regions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from class java.lang.Object
clone, finalize, 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.
  - hasAccounts
```
public boolean hasAccounts()
```
    Returns true if the Accounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - accounts
```
public List<String> accounts()
```
    [Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.
    
    You can specify Accounts or DeploymentTargets, but not both.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAccounts() to see if a value was sent in this field.
    
    Returns:
    
    [Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.
    
    You can specify Accounts or DeploymentTargets, but not both.
  - deploymentTargets
```
public DeploymentTargets deploymentTargets()
```
    [Service-managed permissions] The AWS Organizations accounts from which to delete stack instances.
    
    You can specify Accounts or DeploymentTargets, but not both.
    
    Returns:
    
    [Service-managed permissions] The AWS Organizations accounts from which to delete stack instances.
    
    You can specify Accounts or DeploymentTargets, but not both.
  - hasRegions
```
public boolean hasRegions()
```
    Returns true if the Regions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasRegions() to see if a value was sent in this field.
    
    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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeleteStackInstancesRequest.Builder,DeleteStackInstancesRequest>
    
    Specified by:
    
    toBuilder in class CloudFormationRequest
  - builder
```
public static DeleteStackInstancesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeleteStackInstancesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DeleteStackInstancesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

stackSetName

hasAccounts

accounts

deploymentTargets

hasRegions

regions

operationPreferences

retainStacks

operationId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields