aws-cloudformation-wait-ready

A fork of CumulusDS/aws-cloudformation-wait-ready written in typescript and updated for Node 18.

This utility waits until an AWS CloudFormation Stack is ready to update. It is similar to aws cloudformation wait stack-update-complete but waits for any stack status where an update should be allowed. A feature request for a similar feature from the aws cli has been filed, but not implemented. The feature is useful for CI scripts that test deployment readiness.

Prerequisites

• Node >=18
• AWS auth via environment variables or instance profile

Usage

The following command will allow you run the CLI tool without having to explicitly install it as long as npm is installed.

npx -y -p @vivianhealth/aws-cloudformation-wait-ready@latest \
    aws-cloudformation-wait-ready \
    --stack-name <stack-name>

To install and lock in a specific version into your project dependencies (recommended):

npm install --save-dev @vivianhealth/aws-cloudformation-wait-ready

And then to run the CLI tool inside your project directory:

npx aws-cloudformation-wait-ready \
    --stack-name <stack-name>

Publishing

This package is automatically published to npm via CI. Versions are bumped automatically based on commits since the last release using semantic-release and conventional-changelog.

Commit message format is important. See conventional commits. This format is enforced via git hooks.

License

This package is MIT licensed.

It was originally forked from CumulusDS/aws-cloudformation-wait-ready