@guardian/cdk

Guardian CDK Library

The AWS Cloud Development Kit (AWS CDK) is an open-source software development framework to define cloud infrastructure in code and provision it through AWS CloudFormation.

@guardian/cdk builds on CDK to provide Guardian-specific patterns and constructs. It is an opinionated and secure-by-default way to describe and provision your AWS resources.

Jump to:

• Quickstart
• CDK demo including screencast
• Setting up a new project
• Migrating an existing Cloudformation template
• View the typedocs
• Contributing to @guardian/cdk
• Best practices

Quickstart

@guardian/cdk expects certain Parameter Store values to be present - for example, VPC IDs, and the location of dist buckets. To check for account readiness and fix any issues, run:

npx @guardian/cdk@latest account-readiness --profile [profile]

Once you've confirmed that your account is ready, you can start provisioning your infrastructure.

Tip: Setting up a new project? Start here!

Tip: Migrating an app? See the Migration Guide for more detail.

Tip: New to CDK? The AWS CDK Developer Guide is worth a read.

Contributing

We welcome contributions to @guardian/cdk!

To get started, please read our Contribution Guidelines.

[!NOTE] This repository uses the GitHub App guardian/cdk (requires GitHub admin) for various automations.