java.lang.Object
- software.amazon.awssdk.services.cloudformation.model.StackSetOperation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackSetOperation.Builder,StackSetOperation>
```
@Generated("software.amazon.awssdk:codegen")
public final class StackSetOperation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StackSetOperation.Builder,StackSetOperation>
```
The structure that contains information about a StackSet operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StackSetOperation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`StackSetOperationAction`	`action()`	The type of StackSet operation: `CREATE`, `UPDATE`, or `DELETE`.
`String`	`actionAsString()`	The type of StackSet operation: `CREATE`, `UPDATE`, or `DELETE`.
`String`	`administrationRoleARN()`	The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet operation.
`static StackSetOperation.Builder`	`builder()`
`Instant`	`creationTimestamp()`	The time at which the operation was initiated.
`DeploymentTargets`	`deploymentTargets()`	The Organizations accounts affected by the stack operation.
`Instant`	`endTimestamp()`	The time at which the StackSet operation ended, across all accounts and Regions specified.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleName()`	The name of the IAM execution role used to create or update the StackSet.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`operationId()`	The unique ID of a StackSet operation.
`StackSetOperationPreferences`	`operationPreferences()`	The preferences for how CloudFormation performs this StackSet operation.
`Boolean`	`retainStacks()`	For StackSet operations of action type `DELETE`, specifies whether to remove the stack instances from the specified StackSet, but doesn't delete the stacks.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StackSetOperation.Builder>`	`serializableBuilderClass()`
`StackSetDriftDetectionDetails`	`stackSetDriftDetectionDetails()`	Detailed information about the drift status of the StackSet.
`String`	`stackSetId()`	The ID of the StackSet.
`StackSetOperationStatus`	`status()`	The status of the operation.
`String`	`statusAsString()`	The status of the operation.
`StackSetOperationStatusDetails`	`statusDetails()`	Detailed information about the StackSet operation.
`String`	`statusReason()`	The status of the operation in details.
`StackSetOperation.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - operationId
```
public final String operationId()
```
    The unique ID of a StackSet operation.
    
    Returns:
    
    The unique ID of a StackSet operation.
  - stackSetId
```
public final String stackSetId()
```
    The ID of the StackSet.
    
    Returns:
    
    The ID of the StackSet.
  - action
```
public final StackSetOperationAction action()
```
    The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.
    
    If the service returns an enum value that is not available in the current SDK version, action will return StackSetOperationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.
    
    See Also:
    
    StackSetOperationAction
  - actionAsString
```
public final String actionAsString()
```
    The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.
    
    If the service returns an enum value that is not available in the current SDK version, action will return StackSetOperationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.
    
    See Also:
    
    StackSetOperationAction
  - status
```
public final StackSetOperationStatus status()
```
    The status of the operation.
    
    FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
    
    QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSets status codes in the CloudFormation User Guide.
    
    RUNNING: The operation is currently being performed.
    
    STOPPED: The user has canceled the operation.
    
    STOPPING: The operation is in the process of stopping, at user request.
    
    SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StackSetOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the operation.
    
    FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
    
    QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSets status codes in the CloudFormation User Guide.
    
    RUNNING: The operation is currently being performed.
    
    STOPPED: The user has canceled the operation.
    
    STOPPING: The operation is in the process of stopping, at user request.
    
    SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
    
    See Also:
    
    StackSetOperationStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the operation.
    
    FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
    
    QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSets status codes in the CloudFormation User Guide.
    
    RUNNING: The operation is currently being performed.
    
    STOPPED: The user has canceled the operation.
    
    STOPPING: The operation is in the process of stopping, at user request.
    
    SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StackSetOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the operation.
    
    FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
    
    QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSets status codes in the CloudFormation User Guide.
    
    RUNNING: The operation is currently being performed.
    
    STOPPED: The user has canceled the operation.
    
    STOPPING: The operation is in the process of stopping, at user request.
    
    SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
    
    See Also:
    
    StackSetOperationStatus
  - operationPreferences
```
public final StackSetOperationPreferences operationPreferences()
```
    The preferences for how CloudFormation performs this StackSet operation.
    
    Returns:
    
    The preferences for how CloudFormation performs this StackSet operation.
  - retainStacks
```
public final Boolean retainStacks()
```
    For StackSet operations of action type DELETE, specifies whether to remove the stack instances from the specified StackSet, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new StackSet.
    
    Returns:
    
    For StackSet operations of action type DELETE, specifies whether to remove the stack instances from the specified StackSet, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new StackSet.
  - administrationRoleARN
```
public final String administrationRoleARN()
```
    The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet operation.
    
    Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet operation.
    
    Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.
  - executionRoleName
```
public final String executionRoleName()
```
    The name of the IAM execution role used to create or update the StackSet.
    
    Use customized execution roles to control which stack resources users and groups can include in their StackSets.
    
    Returns:
    
    The name of the IAM execution role used to create or update the StackSet.
    
    Use customized execution roles to control which stack resources users and groups can include in their StackSets.
  - creationTimestamp
```
public final Instant creationTimestamp()
```
    The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
    
    Returns:
    
    The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
  - endTimestamp
```
public final Instant endTimestamp()
```
    The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.
    
    Returns:
    
    The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.
  - deploymentTargets
```
public final DeploymentTargets deploymentTargets()
```
    The Organizations accounts affected by the stack operation. Valid only if the StackSet uses service-managed permissions.
    
    Returns:
    
    The Organizations accounts affected by the stack operation. Valid only if the StackSet uses service-managed permissions.
  - stackSetDriftDetectionDetails
```
public final StackSetDriftDetectionDetails stackSetDriftDetectionDetails()
```
    Detailed information about the drift status of the StackSet. This includes information about drift operations currently being performed on the StackSet.
    
    This information will only be present for StackSet operations whose Action type is DETECT_DRIFT.
    
    For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.
    
    Returns:
    
    Detailed information about the drift status of the StackSet. This includes information about drift operations currently being performed on the StackSet.
    
    This information will only be present for StackSet operations whose Action type is DETECT_DRIFT.
    
    For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.
  - statusReason
```
public final String statusReason()
```
    The status of the operation in details.
    
    Returns:
    
    The status of the operation in details.
  - statusDetails
```
public final StackSetOperationStatusDetails statusDetails()
```
    Detailed information about the StackSet operation.
    
    Returns:
    
    Detailed information about the StackSet operation.
  - toBuilder
```
public StackSetOperation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StackSetOperation.Builder,StackSetOperation>
  - builder
```
public static StackSetOperation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StackSetOperation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StackSetOperation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

operationId

stackSetId

action

actionAsString

status

statusAsString

operationPreferences

retainStacks

administrationRoleARN

executionRoleName

creationTimestamp

endTimestamp

deploymentTargets

stackSetDriftDetectionDetails

statusReason

statusDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField