1.0.1 • Published 6 years ago

@joblocal/aws-cfn-deployment v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

AWS CloudFormation Deployment

Downloads

The Project provides a CLI tool for create and/or update an AWS CloudFormation. aws-cfn-deployment simplifies keeping your AWS infrastructure in sync with your CloudFormation templates by integrating into your existing build & deployment pipelines.

Requirements

  • AWS environment configuration
  • Yarn or npm
  • Node

Installation

Using yarn for global usage:

$ yarn global add @joblocal/aws-cfn-deployment

Using npm for global usage:

$ npm install -g @joblocal/aws-cfn-deployment

Installing as a local dependency using yarn:

$ yarn add @joblocal/aws-cfn-deployment

Installing as a local dependency using npm:

$ npm install @joblocal/aws-cfn-deployment

Usage

Before you can use this package you need to configure your AWS environment variables. The easiest way is to use AWS CLI.

After installing aws-cfn-deployment you can use it as follows.

$ aws-cfn-deployment
  --region {region}
  --stackName {stack name}
  --templatePath {path to your CloudFormation File}
  --{cfn parameter name} {cfn parameter value}
  --{cfn parameter name} {cfn parameter value}
  ...

Parameters

The parameters region, stackName and templatePath are required. All required parameters for your CloudFormation file are attached (see example).

Example

AWS CloudFormation file (bucket.yaml):

---
AWSTemplateFormatVersion: '2010-09-09'
Description: Creates a S3 bucket.
Parameters:
  BucketName:
    Description: Name of your S3 bucket.
    Type: String
Resources:
  DeploymentBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Sub ${AWS::AccountId}-{BucketName}

Command:

$ aws-cfn-deployment
  --region $AWS_DEFAULT_REGION
  --stackName MyBucket
  --templatePath bucket.yaml
  --BucketName AwesomeBucket

Built with

  • Yarn - Dependency Management
  • Jest - Test Runner

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and feature requests.

Authors

See also the list of contributors who participated in this project.