https://github.com/ScottBrenner/aws-cdk-action

GitHub Action for interacting with AWS CDK
https://github.com/ScottBrenner/aws-cdk-action

aws-cdk github-actions hacktoberfest

Last synced: 3 months ago
JSON representation

GitHub Action for interacting with AWS CDK

• Host: GitHub
• URL: https://github.com/ScottBrenner/aws-cdk-action
• Owner: ScottBrenner
• License: mit
• Created: 2019-07-17T01:57:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-27T21:32:31.000Z (9 months ago)
• Last Synced: 2024-05-29T11:32:44.166Z (9 months ago)
• Topics: aws-cdk, github-actions, hacktoberfest
• Language: Dockerfile
• Homepage: https://github.com/marketplace/actions/aws-cdk-action
• Size: 89.8 KB
• Stars: 50
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-repos - ScottBrenner/aws-cdk-action - GitHub Action for interacting with AWS CDK (Dockerfile)

README

        
# GitHub Action for AWS CDK

This Action for [AWS CDK](https://docs.aws.amazon.com/cdk/index.html) enables arbitrary actions for interacting with the AWS Cloud Development Kit (AWS CDK) via the [AWS CDK Toolkit (`cdk` command)](https://docs.aws.amazon.com/cdk/v2/guide/cli.html).

_Currently supports CDK apps created with JavaScript, Go, Python and TypeScript._

## Usage

An example workflow for synthesizing an AWS CloudFormation template for your app using `cdk synth`.

```yaml

name: AWS CDK Synth

on: [push]

jobs:

  aws-cdk-synth:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout

      uses: actions/checkout@v4

    - name: CDK Synth

      uses: scottbrenner/[email protected]

      with:

        args: synth

      env:

        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}

        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

```

### Secrets

- `AWS_ACCESS_KEY_ID` – **Required** The AWS access key part of your credentials ([more info](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys))

- `AWS_SECRET_ACCESS_KEY` – **Required** The AWS secret access key part of your credentials ([more info](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys))

For details on creating secrets and using them with GitHub Actions, see [Creating encrypted secrets for a repository](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository).

### Environment

Each Stack instance in your AWS CDK app is explicitly or implicitly associated with an environment (`env`). An environment is the target AWS account and AWS Region into which this stack needs to be deployed.

See [the CDK developer guide](https://docs.aws.amazon.com/cdk/latest/guide/environments.html) for more information.

## License

The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).

Container images built with this project include third party materials. See [THIRD_PARTY_NOTICE.md](THIRD_PARTY_NOTICE.md) for details.