Interface StackSetOperationSummary.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>,SdkBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>,SdkPojo
- Enclosing class:
- StackSetOperationSummary
@Mutable @NotThreadSafe public static interface StackSetOperationSummary.Builder extends SdkPojo, CopyableBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description StackSetOperationSummary.Builderaction(String action)The type of operation:CREATE,UPDATE, orDELETE.StackSetOperationSummary.Builderaction(StackSetOperationAction action)The type of operation:CREATE,UPDATE, orDELETE.StackSetOperationSummary.BuildercreationTimestamp(Instant creationTimestamp)The time at which the operation was initiated.StackSetOperationSummary.BuilderendTimestamp(Instant endTimestamp)The time at which the StackSet operation ended, across all accounts and Regions specified.StackSetOperationSummary.BuilderoperationId(String operationId)The unique ID of the StackSet operation.default StackSetOperationSummary.BuilderoperationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)The user-specified preferences for how CloudFormation performs a StackSet operation.StackSetOperationSummary.BuilderoperationPreferences(StackSetOperationPreferences operationPreferences)The user-specified preferences for how CloudFormation performs a StackSet operation.StackSetOperationSummary.Builderstatus(String status)The overall status of the operation.StackSetOperationSummary.Builderstatus(StackSetOperationStatus status)The overall status of the operation.default StackSetOperationSummary.BuilderstatusDetails(Consumer<StackSetOperationStatusDetails.Builder> statusDetails)Detailed information about the StackSet operation.StackSetOperationSummary.BuilderstatusDetails(StackSetOperationStatusDetails statusDetails)Detailed information about the StackSet operation.StackSetOperationSummary.BuilderstatusReason(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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
operationId
StackSetOperationSummary.Builder operationId(String operationId)
The unique ID of the StackSet operation.
- Parameters:
operationId- The unique ID of the StackSet operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
action
StackSetOperationSummary.Builder action(String action)
The type of operation:
CREATE,UPDATE, orDELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.- Parameters:
action- The type of operation:CREATE,UPDATE, orDELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StackSetOperationAction,StackSetOperationAction
-
action
StackSetOperationSummary.Builder action(StackSetOperationAction action)
The type of operation:
CREATE,UPDATE, orDELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.- Parameters:
action- The type of operation:CREATE,UPDATE, orDELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StackSetOperationAction,StackSetOperationAction
-
status
StackSetOperationSummary.Builder status(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 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 StackSet 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 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 StackSet 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,StackSetOperationStatus
-
-
status
StackSetOperationSummary.Builder status(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 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 StackSet 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 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 StackSet 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,StackSetOperationStatus
-
-
creationTimestamp
StackSetOperationSummary.Builder creationTimestamp(Instant creationTimestamp)
The time at which the operation was initiated. Note that the creation times for the StackSet 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 StackSet 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
StackSetOperationSummary.Builder endTimestamp(Instant endTimestamp)
The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.
- Parameters:
endTimestamp- The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet 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.
-
statusReason
StackSetOperationSummary.Builder statusReason(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.
-
statusDetails
StackSetOperationSummary.Builder statusDetails(StackSetOperationStatusDetails 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 StackSetOperationSummary.Builder statusDetails(Consumer<StackSetOperationStatusDetails.Builder> statusDetails)
Detailed information about the StackSet operation.
This is a convenience method that creates an instance of theStackSetOperationStatusDetails.Builderavoiding the need to create one manually viaStackSetOperationStatusDetails.builder().When the
Consumercompletes,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:
statusDetails(StackSetOperationStatusDetails)
-
operationPreferences
StackSetOperationSummary.Builder operationPreferences(StackSetOperationPreferences operationPreferences)
The user-specified preferences for how CloudFormation performs a StackSet operation.
For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
- Parameters:
operationPreferences- The user-specified preferences for how CloudFormation performs a StackSet operation.For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationPreferences
default StackSetOperationSummary.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)
The user-specified preferences for how CloudFormation performs a StackSet operation.
For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
This is a convenience method that creates an instance of theStackSetOperationPreferences.Builderavoiding the need to create one manually viaStackSetOperationPreferences.builder().When the
Consumercompletes,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:
operationPreferences(StackSetOperationPreferences)
-
-