Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/poad/aws-cloudformation-stack-status-checker

aws cloudformation github-actions

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/poad/aws-cloudformation-stack-status-checker
Owner: poad
License: mit
Created: 2022-03-12T08:15:22.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-04-11T23:49:17.000Z (9 months ago)
Last Synced: 2024-04-14T10:49:05.020Z (9 months ago)
Topics: aws, cloudformation, github-actions
Language: JavaScript
Homepage:
Size: 24.7 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        # GitHub Action to AWS CloudFormation Stack status checks

[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE)

[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

[![version](https://img.shields.io/github/v/release/poad/aws-cloudformation-stack-status-checker?display_name=tag&include_prereleases&sort=semver)](VERSION)

## Usage

### Retrives status of AWS CloudFormation Stack

```yaml

    - name: 'Retrives status of AWS CloudFormation Stack'

      id: stack-status

      uses: poad/[email protected]

      with: 

        stack-name: 'test-stack'

  

    - name: 'Another example step'

      run: echo ${{ steps.stack-status.outputs.status }}

```

#### Credentials and region

Credential resolve follows the AWS SDK v3 for JavaScript specification.

It is recommended to use [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) to configure credentials in advance.

##### cross regions

The default region can be set via credentials or the environment variable `AWS_REGION`.

To check the stack for a region other than the default region, specify `region` in the Action input as follows

```yaml

    - name: 'Retrives status of AWS CloudFormation Stack'

      id: stack-status

      uses: poad/[email protected]

      with: 

        stack-name: 'test-stack'

        region: us-west-2

```

## License

Any contributions made under this project will be governed by the [MIT License](LICENSE)