J Cole Morrison
J Cole Morrison

J Cole Morrison

DevOps Specialist, Software Engineer, former Techstars Hackstar, and Founder / Instructor at AwsDevops.io!



Complete Guides:

CloudFormation Complete Guide

The Complete CloudFormation Guide: Setting Up Our Series Project

Posted by J Cole Morrison on .

The Complete CloudFormation Guide: Setting Up Our Series Project

Posted by J Cole Morrison on .

The Complete CloudFormation Guide Project Format Version Description Metadata

Table of Contents

  1. Introduction
  2. What Are We Doing?
  3. The Video: Setting Up Our Series Project
  4. The Template So Far
  5. Next Steps
  6. The Complete CloudFormation Guide Index

Introduction

So now we're finally going to dive in and actually get something built with CloudFormation. In the video below we'll begin our journey of examining the full anatomy (aka structure) of a template as we build something for ourselves. This way you can see the pieces come together in practice.

The anatomy of a CloudFormation template has 9 unique sections: the format version, description, metadata, parameters, mappings, conditions, transform, resources, and outputs. And by "has" I mean that it can have, not that every template always includes all nine of these. Each has its own purpose but you don't necessarily need all of them in every template you make. Out of them all, you'll do most of your work with the resources, parameters, and conditions sections. You can see the AWS documentation on template anatomy here which we'll be referencing throughout this launch.

Note: One thing to never ever forget - when listed in your template file (which in this example is in .json format), the properties must begin with upper case letters! I cannot stress this requirement enough. (Let's just say I've forgotten a few times myself.)

What Are We Doing?

In this video, we'll cover the first three sections of AWS CloudFormation template anatomy as we build our security group: the format version, description, and metadata, including a couple special keys in the documentation for that last one. These are the simplest of the nine sections so we'll cover the other six in subsequent videos.

The Video: Setting Up Our Series Project

The Template So Far

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  "Description": "A template for learning and security groups",
  "Metadata": {
    "Author": "J Cole Morrison"
  }
}

Next Steps

The Next Post - Resources

The Previous Post - How CloudFormation Does Updates and Deletes

The Complete CloudFormation Guide Index

If you're enjoying this series and finding it useful, be sure to check out the rest of the blog posts in it! The links below will take you to the other posts in The Complete CloudFormation Guide here on Tech Guides and Thoughts so you can continue building your CloudFormation template along with me.

  1. The Complete CloudFormation Guide
  2. An Introduction to and History of CloudFormation
  3. The Main Concepts of CloudFormation
  4. How CloudFormation Does Updates and Deletes
  5. Our Project Setup
  6. Resources
  7. Parameters and Refs
  8. Our First Time Launch
  9. Functions, Pseudo Parameters, and Conditions Part 1
  10. Functions, Pseudo Parameters, and Conditions Part 2
  11. Mappings
  12. Transforms
  13. Outputs
  14. Relaunch!
  15. The Best Next Steps to Take from Here

Enjoy Posts Like These? Sign up to my mailing list!

My Tech Guides and Thoughts Mailing List

J Cole Morrison

J Cole Morrison

http://start.jcolemorrison.com

DevOps Specialist, Software Engineer, former Techstars Hackstar, and Founder / Instructor at AwsDevops.io!

View Comments...
J Cole Morrison

J Cole Morrison

DevOps Specialist, Software Engineer, former Techstars Hackstar, and Founder / Instructor at AwsDevops.io!



Complete Guides: