Package software.amazon.awssdk.services.cloudformation.model

Interface StackSetOperationSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>, SdkBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>, SdkPojo
Enclosing class:
StackSetOperationSummary
public static interface StackSetOperationSummary.Builder extends SdkPojo, CopyableBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>

  • Method Details

    • operationId

      StackSetOperationSummary.Builder operationId(String operationId)

      The unique ID of the stack set operation.

      Parameters:
      operationId - The unique ID of the stack set 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, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.

      Parameters:
      action - The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      StackSetOperationSummary.Builder action(StackSetOperationAction action)

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

      Parameters:
      action - The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 to FAILED. This in turn sets the status of the operation as a whole to FAILED, 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 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 to FAILED. This in turn sets the status of the operation as a whole to FAILED, 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

      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 to FAILED. This in turn sets the status of the operation as a whole to FAILED, 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 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 to FAILED. This in turn sets the status of the operation as a whole to FAILED, 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:

    • creationTimestamp

      StackSetOperationSummary.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 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

      StackSetOperationSummary.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.

      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.

    • 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 stack set operation.

      Parameters:
      statusDetails - Detailed information about the stack set 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 stack set operation.

      This is a convenience method that creates an instance of the StackSetOperationStatusDetails.Builder avoiding the need to create one manually via StackSetOperationStatusDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statusDetails(StackSetOperationStatusDetails).

      Parameters:
      statusDetails - a consumer that will call methods on StackSetOperationStatusDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operationPreferences

      StackSetOperationSummary.Builder operationPreferences(StackSetOperationPreferences operationPreferences)

      The user-specified preferences for how CloudFormation performs a stack set operation.

      For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

      Parameters:
      operationPreferences - The user-specified preferences for how CloudFormation performs a stack set operation.

      For more information about maximum concurrent accounts and failure tolerance, see Stack set 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 stack set operation.

      For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

      This is a convenience method that creates an instance of the StackSetOperationPreferences.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).

      Parameters:
      operationPreferences - a consumer that will call methods on StackSetOperationPreferences.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: