npm install --save cdk-web aws-sdk
<script src="https://sdk.amazonaws.com/js/aws-sdk-2.1000.0.min.js"></script> <script src="https://unpkg.com/cdk-web"></script>
const CDK = require("cdk-web"); const cdk = CDK.require("aws-cdk-lib"); const ec2 = CDK.require("aws-cdk-lib/aws-ec2"); const sqs = CDK.require("aws-cdk-lib/aws-sqs"); const sns = CDK.require("aws-cdk-lib/aws-sns"); const s3 = CDK.require("aws-cdk-lib/aws-s3"); const app = new cdk.App(); const stack = new cdk.Stack(app, "BrowserStack"); const vpc = new ec2.Vpc(stack, "VPC"); const queue = new sqs.Queue(stack, "Queue"); const topic = new sns.Topic(stack, "Topic"); const bucket = new s3.Bucket(stack, "Bucket"); const assembly = await app.synth(); console.log(assembly);
cdk-webdoes not have a dependency on any NPM packages
cdk-webis and will always be compatible with "strict" mode
cdk-webcore framework weighs a whopping 200MB less than native CDK
cdk-webruns much faster than CDK thanks to it being entirely in-memory
cdk-webis a symmetrical package that works both in Node and web browsers
cdk-webis compressed and goes through the Closure Compiler on each release
cdk-webis arguably securer than CDK, again thanks to it being entirely in-memory
cdk-weballows you to Bring Your Own AWS SDK bundle (details here)
npm run build builds cdk-web. everything is bundled in
you may open up
dist/index.html in your browser if you want to just play with the compiled bundle.
you can build a dev bundle verbosely with
CDK_WEB_DEBUG=1 environment variables set.
testing is done by Puppeteer. the actual generated bundle is loaded into Puppeteer and tests are executed against it.
npm test to execute them. tests are executed twice: once in Puppeteer vs. native CDK as ground truth, and once in
NodeJS to make sure the final bundle is also usable and sane in NodeJS-like environments. Coverage is also collected in
NodeJS mode solely due to the fact that currently the toolchain does not have sufficient support to collect coverage in
Puppeteer (which would be ideal). Although, NodeJS coverage is a good estimate of where everything is at.
cdk-web ships with a single
.d.ts file that gives you the same typings as the native cdk. to get it to work, check
out docs/types.md. typings for
constructs are bundled as well.
The two packages are identical, mirrored, and released to at the same time.
You may use the other mirror if you are behind a corporate proxy and your
NPM packages go through a third-party repository such as Artifactory. The mirror does not list any packages as
devDependencies in its package.json. This prevents
cdk-web to be incorrectly flagged as vulnerable due to its outdated
cdk-web is a compiled project. Its compiler and toolchain being outdated does not impact its runtime.