This repo contains different CDK constructs to assist in setting up static webpages with common features such as: prerender for SEO, regional redirection, data transformation, firewalls, and hosting. All constructs are configurable with the intent to be usable for all use cases.
These are all written for CDK v2. See the offical AWS guide for how to migrate from CDK v1: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html.
| Construct | Description |
|---|---|
| basic-auth | Restricts CloudFront access behind authentication |
| cloudfront-security-headers | Adds HTTP security headers to origin responses |
| feature-env-handlers | Lambda@Edge handlers to support feature environments |
| geoip-redirect | Lambda@Edge handlers to redirect users based on region |
| graphql-server | Creates a GraphQL Mesh server to assist with data transformation from multiple sources |
| prerender-fargate | Self-hosted prerender to handle prerender bot requests |
| prerender-proxy | Provides an functions to adjust self-hosted prerender behaviour |
| rabbitmq | Create a RabbitMQ cluster within CDK |
| shared-vpc | Creates a single VPC with static IP for micro-services with DNS management |
| static-hosting | Construct to deploy infrastructure for static webpage hosting |
| waf | Configurable WAF infrastructure |
Make your changes in the package of choice then
- Build it.
yarn nx build <package_name> - Pack it.
cd dist/<package-name> && npm pack - Import it.
npm i <path_to_tarball>back in your main codebase
From here anytime you rerun the npm pack step your changes will be in sync.
Once happy with the changes and there's no errors update the readme (if there's any functional changes) and create a PR for your branch
Once the changes have been approved, you can commit/merge the changes to the main branch and create a release.
Each construct/package maintains an independent release cycle.
Note that for all the finalized releases, the source branch should be the main branch.
If the release is experimental, you may use the main or the feature branch.
Release Tags When making a release (including experimental releases), the release tag should maintain following formation.
- experimental releases: [package-name]-[version number]-[experimental tag]
- finalized releases: [package-name]-[version number]
Note that the version number should follow [0-9].[0-9].[0-9] structure.
| Experimental | Final |
|---|---|
| 1.1.0-beta | 1.1.0 |