Interface StackSetOperation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StackSetOperation.Builder,
,StackSetOperation> SdkBuilder<StackSetOperation.Builder,
,StackSetOperation> SdkPojo
- Enclosing class:
StackSetOperation
-
Method Summary
Modifier and TypeMethodDescriptionThe type of stack set operation:CREATE
,UPDATE
, orDELETE
.action
(StackSetOperationAction action) The type of stack set operation:CREATE
,UPDATE
, orDELETE
.administrationRoleARN
(String administrationRoleARN) The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.creationTimestamp
(Instant creationTimestamp) The time at which the operation was initiated.default StackSetOperation.Builder
deploymentTargets
(Consumer<DeploymentTargets.Builder> deploymentTargets) [Service-managed permissions] The Organizations accounts affected by the stack operation.deploymentTargets
(DeploymentTargets deploymentTargets) [Service-managed permissions] The Organizations accounts affected by the stack operation.endTimestamp
(Instant endTimestamp) The time at which the stack set operation ended, across all accounts and Regions specified.executionRoleName
(String executionRoleName) The name of the IAM execution role used to create or update the stack set.operationId
(String operationId) The unique ID of a stack set operation.default StackSetOperation.Builder
operationPreferences
(Consumer<StackSetOperationPreferences.Builder> operationPreferences) The preferences for how CloudFormation performs this stack set operation.operationPreferences
(StackSetOperationPreferences operationPreferences) The preferences for how CloudFormation performs this stack set operation.retainStacks
(Boolean retainStacks) For stack set operations of action typeDELETE
, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks.default StackSetOperation.Builder
stackSetDriftDetectionDetails
(Consumer<StackSetDriftDetectionDetails.Builder> stackSetDriftDetectionDetails) Detailed information about the drift status of the stack set.stackSetDriftDetectionDetails
(StackSetDriftDetectionDetails stackSetDriftDetectionDetails) Detailed information about the drift status of the stack set.stackSetId
(String stackSetId) The ID of the stack set.The status of the operation.status
(StackSetOperationStatus status) The status of the operation.default StackSetOperation.Builder
statusDetails
(Consumer<StackSetOperationStatusDetails.Builder> statusDetails) Detailed information about the StackSet operation.statusDetails
(StackSetOperationStatusDetails statusDetails) Detailed information about the StackSet operation.statusReason
(String statusReason) The status of the operation in details.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
action
The type of stack set operation:
CREATE
,UPDATE
, orDELETE
. 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, in addition to all associated stack set instances.- Parameters:
action
- The type of stack set operation:CREATE
,UPDATE
, orDELETE
. 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, in addition to all associated stack set instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
action
The type of stack set operation:
CREATE
,UPDATE
, orDELETE
. 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, in addition to all associated stack set instances.- Parameters:
action
- The type of stack set operation:CREATE
,UPDATE
, orDELETE
. 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, in addition to all associated stack set instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toFAILED
. This in turn sets the status of the operation as a whole toFAILED
, 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 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 toFAILED
. This in turn sets the status of the operation as a whole toFAILED
, 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:
-
-
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 toFAILED
. This in turn sets the status of the operation as a whole toFAILED
, 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 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 toFAILED
. This in turn sets the status of the operation as a whole toFAILED
, 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:
-
-
operationPreferences
The preferences for how CloudFormation performs this stack set operation.
- Parameters:
operationPreferences
- The preferences for how CloudFormation performs this stack set operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationPreferences
default StackSetOperation.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences) The preferences for how CloudFormation performs this stack set operation.
This is a convenience method that creates an instance of theStackSetOperationPreferences.Builder
avoiding the need to create one manually viaStackSetOperationPreferences.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooperationPreferences(StackSetOperationPreferences)
.- Parameters:
operationPreferences
- a consumer that will call methods onStackSetOperationPreferences.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 re-associate a retained stack, or add an existing, saved stack to a new stack set.- Parameters:
retainStacks
- For stack set operations of action typeDELETE
, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate 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.
-
administrationRoleARN
The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
- Parameters:
administrationRoleARN
- The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionRoleName
The name of the IAM execution role used to create or update the stack set.
Use customized execution roles to control which stack resources users and groups can include in their stack sets.
- Parameters:
executionRoleName
- The name of the IAM execution role used to create or update the stack set.Use customized execution roles to control which stack resources users and groups can include in their stack sets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
deploymentTargets
[Service-managed permissions] The Organizations accounts affected by the stack operation.
- Parameters:
deploymentTargets
- [Service-managed permissions] The Organizations accounts affected by the stack operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deploymentTargets
default StackSetOperation.Builder deploymentTargets(Consumer<DeploymentTargets.Builder> deploymentTargets) [Service-managed permissions] The Organizations accounts affected by the stack operation.
This is a convenience method that creates an instance of theDeploymentTargets.Builder
avoiding the need to create one manually viaDeploymentTargets.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todeploymentTargets(DeploymentTargets)
.- Parameters:
deploymentTargets
- a consumer that will call methods onDeploymentTargets.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stackSetDriftDetectionDetails
StackSetOperation.Builder stackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails) Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.
This information will only be present for stack set operations whose
Action
type isDETECT_DRIFT
.For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.
- Parameters:
stackSetDriftDetectionDetails
- Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.This information will only be present for stack set operations whose
Action
type isDETECT_DRIFT
.For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackSetDriftDetectionDetails
default StackSetOperation.Builder stackSetDriftDetectionDetails(Consumer<StackSetDriftDetectionDetails.Builder> stackSetDriftDetectionDetails) Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.
This information will only be present for stack set operations whose
Action
type isDETECT_DRIFT
.For more information, see Detecting Unmanaged Changes in Stack Sets in the CloudFormation User Guide.
This is a convenience method that creates an instance of theStackSetDriftDetectionDetails.Builder
avoiding the need to create one manually viaStackSetDriftDetectionDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostackSetDriftDetectionDetails(StackSetDriftDetectionDetails)
.- Parameters:
stackSetDriftDetectionDetails
- a consumer that will call methods onStackSetDriftDetectionDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
statusDetails
Detailed information about the StackSet operation.
- Parameters:
statusDetails
- Detailed information about the StackSet operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusDetails
default StackSetOperation.Builder statusDetails(Consumer<StackSetOperationStatusDetails.Builder> statusDetails) Detailed information about the StackSet operation.
This is a convenience method that creates an instance of theStackSetOperationStatusDetails.Builder
avoiding the need to create one manually viaStackSetOperationStatusDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatusDetails(StackSetOperationStatusDetails)
.- Parameters:
statusDetails
- a consumer that will call methods onStackSetOperationStatusDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-