This repository has been made redundant by the Projen probject. Please do not use this to bootstrap new CDK constructs. Instead, use projen.
This is a CDK JSII construct starter repo. To use it, clone this repo and then complete all items in the What's Next section.
What is this construct going to do? Who will find it useful?
- Change README contents - replace the contents of each section with the specifics of your construct
- Update package.json
- name
- description
- jsii.targets
- keywords (include "cdk" for enrollment in the Construct Catalog, other keywords will become hashtags)
- repository
- author
- awscdkio (if you'd like an @mention on twitter from the Construct Catalog)
- license
- Rename your construct's class file and test
- Remove this section of the README, you're set
This is a quick first-draft. All the options that will likely need to be added to accomodate a large number of use-cases are still needed. If you'd like to make requests or help update this construct, please open an Issue or a PR.
What AWS resources get created?
What will this example create? Is it the common use case?
new MyConstruct(stack, 'my-construct', {});Are there other common use cases you should show examples of?
What are the inputs to your constructs?
| property | description | example |
|---|
Include any design notes that someone implementing this might find useful
Please open Pull Requests and Issues on the Github Repo.
MIT