Documentation

Documentation can be found here

Example usage

Example stack

Table of Contents

• Installation
• Description
  • Parameter naming
• Setup
• Development
  • Linting
  • Testing
• How To Contribute
  • Bots used
• License

Description

Utility library for writing AWS CDK code in Typescript or NodeJS that provides several benefits:

1. Built-in guidelines/best practices to maintaining clear structure to your AWS Cloudformation resources in usage and naming convention.
2. Cleanup your CDK stack by reducing lines of code needed to add or import select resource types.

Most utility functions force adherence to naming convetion of type: projectName-component identifier-stack environment such as MyProject-Lambda-API-DEV

This enforcement starts from requiring projectName prefix and stackEnv suffix for most components, but it also extends for some to more advanced requirements.

I found these naming conventions to greatly improve the navigation and comprehension of the resource available, as we all know, a consistent naming convention reduces the mental load and speeds up our comprehension and processing of what resources are deployed and how they interconnect.

Installation

With yarn

yarn add aws-cdk-lib-util

or with npm

npm install aws-cdk-lib-util

Setup

Import

import { CDKCustomResourceUtil, SSMUtil, etc... } from 'aws-cdk-lib-util';

Development

Linting

yarn lint

Testing

yarn test

jest is used for as the testing framework.

Testing coverage is enforced via the jest.config.js to 100% across the board.

How to Contribute

1. Clone repo and create a new branch:

git checkout https://github.com/crisboarna/aws-cdk-lib-util -b name_for_new_branch`.

2. Make changes and test
3. Submit Pull Request with comprehensive description of changes

Bots used

To facilitate development the following bots are integrated into the repository:

1. Request Info
2. Semantic Pull Requests
3. Welcome
4. Snyk
5. Todo

License

Full license details can be found in LICENSE.md