StackInstancesDeployment - AWS CloudFormation
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

StackInstancesDeployment

Provides visibility into the stack instances deployment stage of a StackSet operation, including per-stack-instance progress counts and a completion percentage. For service-managed operations that provision roles, this stage begins after role provisioning finishes.

Contents

CancelledStackInstancesCount

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

FailedStackInstancesCount

The number of stack instances that failed to deploy.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

PercentageCompleted

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

Type: Double

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

SkippedStackInstancesCount

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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.

Type: String

Valid Values: PENDING | NOT_APPLICABLE | NOT_STARTED | IN_PROGRESS | SUCCEEDED | PARTIAL_SUCCESS | FAILED

Required: No

SucceededStackInstancesCount

The number of stack instances that deployed successfully.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: