com.amazonaws.services.cloudformation.model

Class StackSetOperation

java.lang.Object

com.amazonaws.services.cloudformation.model.StackSetOperation

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StackSetOperation
extends Object
implements Serializable, Cloneable

The structure that contains information about a stack set operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StackSetOperation()

Method Summary

Modifier and Type	Method and Description
StackSetOperation	clone()
boolean	equals(Object obj)
String	getAction() The type of stack set 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 a stack set operation.
StackSetOperationPreferences	getOperationPreferences() The preferences for how AWS CloudFormation performs this stack set operation.
Boolean	getRetainStacks() For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks.
String	getStackSetId() The ID of the stack set.
String	getStatus() The status of the operation.
int	hashCode()
Boolean	isRetainStacks() For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks.
void	setAction(StackSetOperationAction action) The type of stack set operation: CREATE, UPDATE, or DELETE.
void	setAction(String action) The type of stack set 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 a stack set operation.
void	setOperationPreferences(StackSetOperationPreferences operationPreferences) The preferences for how AWS CloudFormation performs this stack set operation.
void	setRetainStacks(Boolean retainStacks) For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks.
void	setStackSetId(String stackSetId) The ID of the stack set.
void	setStatus(StackSetOperationStatus status) The status of the operation.
void	setStatus(String status) The status of the operation.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StackSetOperation	withAction(StackSetOperationAction action) The type of stack set operation: CREATE, UPDATE, or DELETE.
StackSetOperation	withAction(String action) The type of stack set operation: CREATE, UPDATE, or DELETE.
StackSetOperation	withCreationTimestamp(Date creationTimestamp) The time at which the operation was initiated.
StackSetOperation	withEndTimestamp(Date endTimestamp) The time at which the stack set operation ended, across all accounts and regions specified.
StackSetOperation	withOperationId(String operationId) The unique ID of a stack set operation.
StackSetOperation	withOperationPreferences(StackSetOperationPreferences operationPreferences) The preferences for how AWS CloudFormation performs this stack set operation.
StackSetOperation	withRetainStacks(Boolean retainStacks) For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks.
StackSetOperation	withStackSetId(String stackSetId) The ID of the stack set.
StackSetOperation	withStatus(StackSetOperationStatus status) The status of the operation.
StackSetOperation	withStatus(String status) The status of the operation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StackSetOperation

public StackSetOperation()

Method Detail

setOperationId

public void setOperationId(String operationId)

The unique ID of a stack set operation.

Parameters:

operationId - The unique ID of a stack set operation.

getOperationId

public String getOperationId()

The unique ID of a stack set operation.

Returns:

The unique ID of a stack set operation.

withOperationId

public StackSetOperation withOperationId(String operationId)

The unique ID of a stack set operation.

Parameters:

operationId - The unique ID of a stack set operation.

Returns:

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

setStackSetId

public void setStackSetId(String stackSetId)

The ID of the stack set.

Parameters:

stackSetId - The ID of the stack set.

getStackSetId

public String getStackSetId()

The ID of the stack set.

Returns:

The ID of the stack set.

withStackSetId

public StackSetOperation withStackSetId(String stackSetId)

The ID of the stack set.

Parameters:

stackSetId - The ID of the stack set.

Returns:

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

setAction

public void setAction(String action)

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

Parameters:

action - The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

See Also:

StackSetOperationAction

getAction

public String getAction()

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

Returns:

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

See Also:

StackSetOperationAction

withAction

public StackSetOperation withAction(String action)

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

Parameters:

action - The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as 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 stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

Parameters:

action - The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

See Also:

StackSetOperationAction

withAction

public StackSetOperation withAction(StackSetOperationAction action)

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

Parameters:

action - The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 StackSetOperation withStatus(String 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 StackSetOperation withStatus(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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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 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 AWS CloudFormation cancels the operation in any remaining regions.

• RUNNING: The operation is currently being performed.

• STOPPED: The user has cancelled 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

setOperationPreferences

public void setOperationPreferences(StackSetOperationPreferences operationPreferences)

The preferences for how AWS CloudFormation performs this stack set operation.

Parameters:

operationPreferences - The preferences for how AWS CloudFormation performs this stack set operation.

getOperationPreferences

public StackSetOperationPreferences getOperationPreferences()

The preferences for how AWS CloudFormation performs this stack set operation.

Returns:

The preferences for how AWS CloudFormation performs this stack set operation.

withOperationPreferences

public StackSetOperation withOperationPreferences(StackSetOperationPreferences operationPreferences)

The preferences for how AWS CloudFormation performs this stack set operation.

Parameters:

operationPreferences - The preferences for how AWS CloudFormation performs this stack set operation.

Returns:

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

setRetainStacks

public void setRetainStacks(Boolean retainStacks)

For stack set operations of action type DELETE, specifies whether to remove 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.

Parameters:

retainStacks - For stack set operations of action type DELETE, specifies whether to remove 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.

getRetainStacks

public Boolean getRetainStacks()

For stack set operations of action type DELETE, specifies whether to remove 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.

Returns:

For stack set operations of action type DELETE, specifies whether to remove 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.

withRetainStacks

public StackSetOperation withRetainStacks(Boolean retainStacks)

For stack set operations of action type DELETE, specifies whether to remove 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.

Parameters:

retainStacks - For stack set operations of action type DELETE, specifies whether to remove 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.

Returns:

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

isRetainStacks

public Boolean isRetainStacks()

For stack set operations of action type DELETE, specifies whether to remove 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.

Returns:

For stack set operations of action type DELETE, specifies whether to remove 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.

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 AWS 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 AWS 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 AWS 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 AWS 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 StackSetOperation 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 AWS 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 AWS 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 StackSetOperation 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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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 StackSetOperation clone()

Overrides:

clone in class Object