DEV Community

loading...
Cover image for Autocomplete your CloudFormation Resources in VS Code
AWS Community Builders

Autocomplete your CloudFormation Resources in VS Code

dannysteenman profile image Danny Steenman Originally published at dannys.cloud on ใƒป2 min read

If you use CloudFormation to provision your infrastructure in AWS, it can be time-consuming to constantly visit the AWS documentation in order to find the right property of each resource type. To solve this problem, I created a VS Code extension that adds autocompletion for every available AWS resource type in a CloudFormation template.

The VS Code extension is called CloudFormation Snippets.

cloudformation-snippets.jpg

Features

The VS Code extension contains the following features:

  1. Autocompletion for every CloudFormation resource type (including properties).
  2. Support for Intrinsic functions & Conditions.
  3. Contains a whole bunch of Parameter types.
  4. Use Tab to quickly update the property of a CloudFormation resource type.
  5. The description of every resource type contains a reference to the official documentation.
  6. Github actions will automatically trigger the pipeline and fetch the latest updates from the official AWS CloudFormation resource specification.

Usage

Here is a small demo that shows what happens when you're trying to add a new CloudFormation resource with the VS Code extension enabled:

cloudformation-snippets-demo.gif

Steps described in further detail:

  • Step 1. Install the extension in your VS Code editor
  • Step 2. Create a template file in .yml format to start working on CloudFormation
  • Step 3. Make sure that the file type is listed as YAML in the VS Code editor (Bottom right-hand corner).
  • Step 4. Type cfn to get the CloudFormation template fragment.
  • Step 5. Start adding resources in the resource section of the template by using the prefix name e.g. autoscaling-autoscalinggroup equals resource type AWS::AutoScaling::AutoScalingGroup

Note: If the autocomplete doesn't get invoked automatically in step 5. Then you can invoke IntelliSense manually by pressing ctrl + space. Search for the prefix of the resource type that you want to add and press Enter.

More helpful VS Code extensions for CloudFormation

If you're looking to optimize your VS Code with more useful extensions, then have a look at the other article I wrote to help you level up your templating game!


๐Ÿ‘‹ Liked this article? Follow me on Twitter to stay updated!

Discussion (0)

Forem Open with the Forem app