@Generated(value="software.amazon.awssdk:codegen") public final class StackSetOperation extends Object implements ToCopyableBuilder<StackSetOperation.Builder,StackSetOperation>
The structure that contains information about a stack set operation.
Modifier and Type | Class and Description |
---|---|
static interface |
StackSetOperation.Builder |
Modifier and Type | Method and Description |
---|---|
StackSetOperationAction |
action()
The type of stack set operation:
CREATE , UPDATE , or DELETE . |
String |
actionAsString()
The type of stack set operation:
CREATE , UPDATE , or DELETE . |
static StackSetOperation.Builder |
builder() |
Instant |
creationTimestamp()
The time at which the operation was initiated.
|
Instant |
endTimestamp()
The time at which the stack set operation ended, across all accounts and regions specified.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
operationId()
The unique ID of a stack set operation.
|
StackSetOperationPreferences |
operationPreferences()
The preferences for how AWS CloudFormation performs this stack set operation.
|
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. |
static Class<? extends StackSetOperation.Builder> |
serializableBuilderClass() |
String |
stackSetId()
The ID of the stack set.
|
StackSetOperationStatus |
status()
The status of the operation.
|
String |
statusAsString()
The status of the operation.
|
StackSetOperation.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String operationId()
The unique ID of a stack set operation.
public String stackSetId()
The ID of the stack set.
public 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.
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()
.
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.StackSetOperationAction
public String actionAsString()
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.
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()
.
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.StackSetOperationAction
public 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.
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()
.
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.
StackSetOperationStatus
public 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 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.
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()
.
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.
StackSetOperationStatus
public StackSetOperationPreferences operationPreferences()
The preferences for how AWS CloudFormation performs this stack set operation.
public 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.
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.public 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 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.
public Instant 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.
public StackSetOperation.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StackSetOperation.Builder,StackSetOperation>
public static StackSetOperation.Builder builder()
public static Class<? extends StackSetOperation.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.