I created an extension for AWS CDK that adds all available L1 constructs from AWS CDK into Visual Studio Code in the form of snippets.
Basically, it will autocomplete any CloudFormation resource you specify including its properties + values.
The VS Code extension is called CDK Construct Snippets
For now, the VS Code extension only supports TypeScript. But if you want to help out and make it available for more programming languages, then you can help by contributing in the GitHub repository
Table of Contents
Features
The VS Code extension contains the following features:
- Supports all resources that are defined by CloudFormation in the form of L1 constructs in AWS CDK
- Triggers autocomplete by invoking
l1-<cloudformation-resource>
- The construct snippets are automatically updated every week after AWS updates their CloudFormation Resource Specification.
- Has built-in support for placeholders. This means you can quickly jump from property to property in each resource by using
Tab
- The extension will show which property is required by adding a
// required
comment next to it. - The autocomplete prompt shows the matching AWS CDK resource documentation URL in its description.
Usage
- Step 1. Install this extension
- Step 2. Start working in your AWS CDK project (TypeScript)
- Step 3. Start adding L1 constructs in your code by using their prefix name e.g.
l1-s3-bucket
equals to L1 constructs3.CfnBucket
Note: Once you start typing a prefix (explained in step 3), the corresponding snippet shows up in the dropdown menu. If this doesn’t happen automatically, press
ctrl + space
to invoke IntelliSense and search for the prefix of the resource type that you want to add (as listed in step 3).
Have a look at a VS Code extension I made for AWS CloudFormation
If you’re working with AWS CloudFormation, then you might be interested in my other VS Code extension that I created which adds autocomplete snippets for all the AWS CloudFormation resources for YAML templates.
Elevate Your AWS CDK App with Expert Review & Guidance
Unlock the full potential of your AWS CDK app with our Expert AWS CDK App Code Review Service, conveniently delivered through AWS IQ.
Gain invaluable insights, minimize risks, and set a clear path forward for your project’s success.