Interface StackInstancesDeployment.Builder

  • Method Details

    • status

      The status of the stack instances deployment stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation.

      • NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached.

      • IN_PROGRESS: At least one stack instance has started deploying.

      • SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped.

      • PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances.

      • FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.

      Parameters:
      status - The status of the stack instances deployment stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation.

      • NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached.

      • IN_PROGRESS: At least one stack instance has started deploying.

      • SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped.

      • PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances.

      • FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of the stack instances deployment stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation.

      • NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached.

      • IN_PROGRESS: At least one stack instance has started deploying.

      • SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped.

      • PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances.

      • FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.

      Parameters:
      status - The status of the stack instances deployment stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation.

      • NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached.

      • IN_PROGRESS: At least one stack instance has started deploying.

      • SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped.

      • PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances.

      • FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • succeededStackInstancesCount

      StackInstancesDeployment.Builder succeededStackInstancesCount(Integer succeededStackInstancesCount)

      The number of stack instances that deployed successfully.

      Parameters:
      succeededStackInstancesCount - The number of stack instances that deployed successfully.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • failedStackInstancesCount

      StackInstancesDeployment.Builder failedStackInstancesCount(Integer failedStackInstancesCount)

      The number of stack instances that failed to deploy.

      Parameters:
      failedStackInstancesCount - The number of stack instances that failed to deploy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • completedStackInstancesCount

      StackInstancesDeployment.Builder completedStackInstancesCount(Integer completedStackInstancesCount)

      The number of stack instances that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.

      Parameters:
      completedStackInstancesCount - The number of stack instances that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • pendingStackInstancesCount

      StackInstancesDeployment.Builder pendingStackInstancesCount(Integer pendingStackInstancesCount)

      The number of stack instances that have not reached a final state. This is the total number of stack instances minus the completed count.

      Parameters:
      pendingStackInstancesCount - The number of stack instances that have not reached a final state. This is the total number of stack instances minus the completed count.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • cancelledStackInstancesCount

      StackInstancesDeployment.Builder cancelledStackInstancesCount(Integer cancelledStackInstancesCount)

      The number of stack instances that were canceled because the operation exceeded its failure tolerance or was stopped.

      Parameters:
      cancelledStackInstancesCount - The number of stack instances that were canceled because the operation exceeded its failure tolerance or was stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • skippedStackInstancesCount

      StackInstancesDeployment.Builder skippedStackInstancesCount(Integer skippedStackInstancesCount)

      The number of stack instances that were skipped because role provisioning failed for their target account.

      Parameters:
      skippedStackInstancesCount - The number of stack instances that were skipped because role provisioning failed for their target account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • percentageCompleted

      StackInstancesDeployment.Builder percentageCompleted(Double percentageCompleted)

      The percentage of stack instances that have reached a final state.

      Parameters:
      percentageCompleted - The percentage of stack instances that have reached a final state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.