StackSetOperationSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudformation.model.StackSetOperationSummary

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StackSetOperationSummary
extends Object
implements Serializable, Cloneable
```
The structures that contain summary information about the specified operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StackSetOperationSummary()

Constructors
Constructor and Description
`StackSetOperationSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StackSetOperationSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The type of operation: `CREATE`, `UPDATE`, or `DELETE`.
`Date`	`getCreationTimestamp()` The time at which the operation was initiated.
`Date`	`getEndTimestamp()` The time at which the stack set operation ended, across all accounts and Regions specified.
`String`	`getOperationId()` The unique ID of the stack set operation.
`StackSetOperationPreferences`	`getOperationPreferences()` The user-specified preferences for how CloudFormation performs a stack set operation.
`String`	`getStatus()` The overall status of the operation.
`StackSetOperationStatusDetails`	`getStatusDetails()` Detailed information about the stack set operation.
`String`	`getStatusReason()` The status of the operation in details.
`int`	`hashCode()`
`void`	`setAction(StackSetOperationAction action)` The type of operation: `CREATE`, `UPDATE`, or `DELETE`.
`void`	`setAction(String action)` The type of operation: `CREATE`, `UPDATE`, or `DELETE`.
`void`	`setCreationTimestamp(Date creationTimestamp)` The time at which the operation was initiated.
`void`	`setEndTimestamp(Date endTimestamp)` The time at which the stack set operation ended, across all accounts and Regions specified.
`void`	`setOperationId(String operationId)` The unique ID of the stack set operation.
`void`	`setOperationPreferences(StackSetOperationPreferences operationPreferences)` The user-specified preferences for how CloudFormation performs a stack set operation.
`void`	`setStatus(StackSetOperationStatus status)` The overall status of the operation.
`void`	`setStatus(String status)` The overall status of the operation.
`void`	`setStatusDetails(StackSetOperationStatusDetails statusDetails)` Detailed information about the stack set operation.
`void`	`setStatusReason(String statusReason)` The status of the operation in details.
`String`	`toString()` Returns a string representation of this object.
`StackSetOperationSummary`	`withAction(StackSetOperationAction action)` The type of operation: `CREATE`, `UPDATE`, or `DELETE`.
`StackSetOperationSummary`	`withAction(String action)` The type of operation: `CREATE`, `UPDATE`, or `DELETE`.
`StackSetOperationSummary`	`withCreationTimestamp(Date creationTimestamp)` The time at which the operation was initiated.
`StackSetOperationSummary`	`withEndTimestamp(Date endTimestamp)` The time at which the stack set operation ended, across all accounts and Regions specified.
`StackSetOperationSummary`	`withOperationId(String operationId)` The unique ID of the stack set operation.
`StackSetOperationSummary`	`withOperationPreferences(StackSetOperationPreferences operationPreferences)` The user-specified preferences for how CloudFormation performs a stack set operation.
`StackSetOperationSummary`	`withStatus(StackSetOperationStatus status)` The overall status of the operation.
`StackSetOperationSummary`	`withStatus(String status)` The overall status of the operation.
`StackSetOperationSummary`	`withStatusDetails(StackSetOperationStatusDetails statusDetails)` Detailed information about the stack set operation.
`StackSetOperationSummary`	`withStatusReason(String statusReason)` The status of the operation in details.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StackSetOperationSummary
```
public StackSetOperationSummary()
```
- Method Detail
  - setOperationId
```
public void setOperationId(String operationId)
```
    The unique ID of the stack set operation.
    
    Parameters:
    
    operationId - The unique ID of the stack set operation.
  - getOperationId
```
public String getOperationId()
```
    The unique ID of the stack set operation.
    
    Returns:
    
    The unique ID of the stack set operation.
  - withOperationId
```
public StackSetOperationSummary withOperationId(String operationId)
```
    The unique ID of the stack set operation.
    
    Parameters:
    
    operationId - The unique ID of the stack set operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(String action)
```
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    Parameters:
    
    action - The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    See Also:
    
    StackSetOperationAction
  - getAction
```
public String getAction()
```
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    Returns:
    
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    See Also:
    
    StackSetOperationAction
  - withAction
```
public StackSetOperationSummary withAction(String action)
```
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    Parameters:
    
    action - The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackSetOperationAction
  - setAction
```
public void setAction(StackSetOperationAction action)
```
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    Parameters:
    
    action - The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    See Also:
    
    StackSetOperationAction
  - withAction
```
public StackSetOperationSummary withAction(StackSetOperationAction action)
```
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    Parameters:
    
    action - The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackSetOperationAction
  - setStatus
```
public void setStatus(String status)
```
    The overall 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 stack set operation 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.
    Parameters:
    status - The overall 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 stack set operation 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
  - getStatus
```
public String getStatus()
```
    The overall 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 stack set operation 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.
    Returns:
    The overall 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 stack set operation 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
  - withStatus
```
public StackSetOperationSummary withStatus(String status)
```
    The overall 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 stack set operation 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.
    Parameters:
    status - The overall 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 stack set operation 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackSetOperationStatus
  - setStatus
```
public void setStatus(StackSetOperationStatus status)
```
    The overall 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 stack set operation 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.
    Parameters:
    status - The overall 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 stack set operation 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
  - withStatus
```
public StackSetOperationSummary withStatus(StackSetOperationStatus status)
```
    The overall 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 stack set operation 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.
    Parameters:
    status - The overall 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 stack set operation 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackSetOperationStatus
  - setCreationTimestamp
```
public void setCreationTimestamp(Date 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.
    
    Parameters:
    
    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.
  - getCreationTimestamp
```
public Date getCreationTimestamp()
```
    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.
  - withCreationTimestamp
```
public StackSetOperationSummary withCreationTimestamp(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTimestamp
```
public void setEndTimestamp(Date endTimestamp)
```
    The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
    
    Parameters:
    
    endTimestamp - The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
  - getEndTimestamp
```
public Date getEndTimestamp()
```
    The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
    
    Returns:
    
    The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
  - withEndTimestamp
```
public StackSetOperationSummary withEndTimestamp(Date endTimestamp)
```
    The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
    
    Parameters:
    
    endTimestamp - The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The status of the operation in details.
    
    Parameters:
    
    statusReason - The status of the operation in details.
  - getStatusReason
```
public String getStatusReason()
```
    The status of the operation in details.
    
    Returns:
    
    The status of the operation in details.
  - withStatusReason
```
public StackSetOperationSummary withStatusReason(String statusReason)
```
    The status of the operation in details.
    
    Parameters:
    
    statusReason - The status of the operation in details.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusDetails
```
public void setStatusDetails(StackSetOperationStatusDetails statusDetails)
```
    Detailed information about the stack set operation.
    
    Parameters:
    
    statusDetails - Detailed information about the stack set operation.
  - getStatusDetails
```
public StackSetOperationStatusDetails getStatusDetails()
```
    Detailed information about the stack set operation.
    
    Returns:
    
    Detailed information about the stack set operation.
  - withStatusDetails
```
public StackSetOperationSummary withStatusDetails(StackSetOperationStatusDetails statusDetails)
```
    Detailed information about the stack set operation.
    
    Parameters:
    
    statusDetails - Detailed information about the stack set operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperationPreferences
```
public void setOperationPreferences(StackSetOperationPreferences operationPreferences)
```
    The user-specified preferences for how CloudFormation performs a stack set operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
    
    Parameters:
    
    operationPreferences - The user-specified preferences for how CloudFormation performs a stack set operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
  - getOperationPreferences
```
public StackSetOperationPreferences getOperationPreferences()
```
    The user-specified preferences for how CloudFormation performs a stack set operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
    
    Returns:
    
    The user-specified preferences for how CloudFormation performs a stack set operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
  - withOperationPreferences
```
public StackSetOperationSummary withOperationPreferences(StackSetOperationPreferences operationPreferences)
```
    The user-specified preferences for how CloudFormation performs a stack set operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
    
    Parameters:
    
    operationPreferences - The user-specified preferences for how CloudFormation performs a stack set operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StackSetOperationSummary clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.772

Class StackSetOperationSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StackSetOperationSummary

Method Detail

setOperationId

getOperationId

withOperationId

setAction

getAction

withAction

setAction

withAction

setStatus

getStatus

withStatus

setStatus

withStatus

setCreationTimestamp

getCreationTimestamp

withCreationTimestamp

setEndTimestamp

getEndTimestamp

withEndTimestamp

setStatusReason

getStatusReason

withStatusReason

setStatusDetails

getStatusDetails

withStatusDetails

setOperationPreferences

getOperationPreferences

withOperationPreferences

toString

equals

hashCode

clone