cfn-exec

This is Wrapper tool for aws cloudformation create stack.

Installation

1. Open AWS Cloudshell or any terminal configured with aws cli.
2. Install cfn-exec

pip3 install cfnexec

3. Create stack with CFn file or url and parameter file or url

cfn-exec -n $your_stack_name -i $your_cfn_url -p $your_cfn_parameter_url 

note: If you are using the nested call function of Cloudformation, you need to make the called file accessible in advance.

cli options

TBD

parameter file format

Support "Cloudformation official format" or "Simple format" Cloudformation official format

[
  {
    "ParameterKey": "ParameterKeyName1",
    "ParameterValue": "ParameterValue1"
  },
  {
    "ParameterKey": "ParameterKeyName2",
    "ParameterValue": "ParameterValue2"
  },
  ...
],

---
- ParameterKey: ParameterKeyName1
  ParameterValue: ParameterValue1
- ParameterKey: ParameterKeyName2
  ParameterValue: ParameterValue2
  ...

Simple format

{
  "ParameterKeyName1": "ParameterValue1",
  "ParameterKeyName2": "ParameterValue2",
  ...
}

---
ParameterKeyName1: ParameterValue1
ParameterKeyName2: ParameterValue2
...

Nested Template

If the --input-path Cloudformation template has a nested structure that references another template, note the following

• If --input-path is set by URL, all referenced templates must have been placed at the referenced URL in advance.
• If --input-path is set as a local file, the referenced template must be located under the folder where the target local file is located. Also, the referenced URL must be able to be changed via parameters.

Reference to local files with nested structure

This is a reference example of a Cloudformation file with a nested structure set by --input-path.

AWSTemplateFormatVersion: "2010-09-09"
Description: main.yml
Parameters: 
  TemplateS3BucketURL:
    Description: Referenced S3 bucket URL
    Type: String
    Default: TemplateS3BucketURL
  BucketName:
    Type: String
    Default: BucketName

Resources:
  # Create S3 Bucket
  S3:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: !Sub ${TemplateS3BucketURL}/components/s3.yml
      Parameters:
        BucketName: !Ref BucketName

This is a reference example of a Cloudformation file with a nested structure set by --input-path.

AWSTemplateFormatVersion: "2010-09-09"
Description: s3.yml
Parameters:
  BucketName:
    Type: String
    Default: "BucketName"

Resources:
  S3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Ref BucketName

This is an example of a parameter file.

TemplateS3BucketURL: TemplateS3BucketURL
BucketName: cfnexec-example-test-01234567890123456789

This is the folder tree of the local file.

.
└── example
    ├── param.yml
    └── input
        ├── main.yml
        └── components
            └── s3.yml

This is an example of execution.

cfn-exec -n example-stack -i ./example/input/main.yml -p ./example/param.yml -s3 TemplateS3BucketURL

Usage

Supported Cloudformation and parameter files are written in json or yaml format, and can be located at local, S3, or public URLs.

local file

cfn-exec -n example-stack -i ./example/input/main.yml -p ./example/param.yml

s3 file

cfn-exec -n example-stack -i https://yourbucket.s3.us-east-1.amazonaws.com/main.yml -p https://yourbucket.s3.us-east-1.amazonaws.com/param.yml

public file

cfn-exec -n example-stack -i https://raw.githubusercontent.com/youraccount/yourrepo/main/input/main.yml -p https://raw.githubusercontent.com/youraccount/yourrepo/main/param.yml