){kind=icon}
){kind=icon}
Documentation can be found here
Utility library for writing AWS CDK code in Typescript or NodeJS that provides several benefits:
- Built-in guidelines/best practices to maintaining clear structure to your
AWS Cloudformationresources in usage and naming convention. - Cleanup your
CDKstack 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.
With yarn
yarn add aws-cdk-lib-utilor with npm
npm install aws-cdk-lib-utilImport
import { CDKCustomResourceUtil, SSMUtil, etc... } from 'aws-cdk-lib-util';yarn lintyarn testjest is used for as the testing framework.
Testing coverage is enforced via the jest.config.js to 100% across the board.
- Clone repo and create a new branch:
git checkout https://github.com/crisboarna/aws-cdk-lib-util -b name_for_new_branch`.- Make changes and test
- Submit Pull Request with comprehensive description of changes
To facilitate development the following bots are integrated into the repository:
Full license details can be found in LICENSE.md