Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

cdklabs/awscdk-change-analyzer

AWS CDK Change Analyzer

The CDK Change Analyzer (C2A) is a tool that helps you:

  • Review the changes that a CDK deployment will introduce to your infrastructure in a visual interface.
  • Write rules to automatically classify certain changes as "safe" or "unsafe", making sure you only need to review changes if there is something important to review.

CDK Change Analyzer can be used independently, or as an integration with CDK Pipelines.

C2A: Developer Preview

C2A is currently in Developer Preview. Let us know how this tool is working for you.

Usage

To use C2A:

  1. Add a PerformChangeAnalysis step to your CDK pipeline.
  2. Create a JSON file to encode your own rules to save yourself manual reviewing time.

Repository Structure

The CDK Change Analyzer suite of tools consists of multiple packages in this repository. The packages are:

| Package | Purpose | |---------|-----------------------------------| | aws-c2a | A CLI to run C2A on a Cloud Assembly | | @aws-c2a/cdk-pipelines-step | A custom approval step for use with CDK Pipelines | | @aws-c2a/rules | Defines the rules language used by C2A to automatically identify changes to approve | | @aws-c2a/visualizer | A tool to visualize the graph model underlying the C2A rules. | | @aws-c2a/presets | Rules packs that are vended by AWS | | @aws-c2a/web-app | The web interface that displays the differences between a deployed CDK application and an upcoming revision | | @aws-c2a/models | Definition of the C2A object model | | @aws-c2a/engine | The engine that analyzes and reports changes between two instances of the model |

c2a - architecture

Developing

We use yarn workspaces and lerna to manage our monorepo. To learn more about the repository structure, check out the documentation here.

deploy the app/integ.nested-stacks.js file yarn workspace aws-c2a run start
nested-stacks ```

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more
information.

## License

This project is licensed under the Apache-2.0 License.

About

A toolkit that analyzes the differences between two cloud infrastructures states.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages