public static interface StackSetOperation.Builder extends CopyableBuilder<StackSetOperation.Builder,StackSetOperation>
Modifier and Type | Method and Description |
---|---|
StackSetOperation.Builder |
action(StackSetOperationAction action)
The type of stack set operation:
CREATE , UPDATE , or DELETE . |
StackSetOperation.Builder |
action(String action)
The type of stack set operation:
CREATE , UPDATE , or DELETE . |
StackSetOperation.Builder |
creationTimestamp(Instant creationTimestamp)
The time at which the operation was initiated.
|
StackSetOperation.Builder |
endTimestamp(Instant endTimestamp)
The time at which the stack set operation ended, across all accounts and regions specified.
|
StackSetOperation.Builder |
operationId(String operationId)
The unique ID of a stack set operation.
|
default StackSetOperation.Builder |
operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)
The preferences for how AWS CloudFormation performs this stack set operation.
|
StackSetOperation.Builder |
operationPreferences(StackSetOperationPreferences operationPreferences)
The preferences for how AWS CloudFormation performs this stack set operation.
|
StackSetOperation.Builder |
retainStacks(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.Builder |
stackSetId(String stackSetId)
The ID of the stack set.
|
StackSetOperation.Builder |
status(StackSetOperationStatus status)
The status of the operation.
|
StackSetOperation.Builder |
status(String status)
The status of the operation.
|
copy
applyMutation, build
StackSetOperation.Builder operationId(String operationId)
The unique ID of a stack set operation.
operationId
- The unique ID of a stack set operation.StackSetOperation.Builder stackSetId(String stackSetId)
The ID of the stack set.
stackSetId
- The ID of the stack set.StackSetOperation.Builder action(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.
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.StackSetOperationAction
,
StackSetOperationAction
StackSetOperation.Builder action(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.
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.StackSetOperationAction
,
StackSetOperationAction
StackSetOperation.Builder status(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.
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.
StackSetOperationStatus
,
StackSetOperationStatus
StackSetOperation.Builder status(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.
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.
StackSetOperationStatus
,
StackSetOperationStatus
StackSetOperation.Builder operationPreferences(StackSetOperationPreferences operationPreferences)
The preferences for how AWS CloudFormation performs this stack set operation.
operationPreferences
- The preferences for how AWS CloudFormation performs this stack set operation.default StackSetOperation.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)
The preferences for how AWS CloudFormation performs this stack set operation.
This is a convenience that creates an instance of theStackSetOperationPreferences.Builder
avoiding
the need to create one manually via StackSetOperationPreferences.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to operationPreferences(StackSetOperationPreferences)
.operationPreferences
- a consumer that will call methods on StackSetOperationPreferences.Builder
operationPreferences(StackSetOperationPreferences)
StackSetOperation.Builder retainStacks(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.
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.StackSetOperation.Builder creationTimestamp(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.
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.StackSetOperation.Builder endTimestamp(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.
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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.