https://github.com/joblocal/aws-cfn-deployment
https://github.com/joblocal/aws-cfn-deployment
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/joblocal/aws-cfn-deployment
- Owner: joblocal
- Created: 2019-01-11T15:25:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-25T13:21:24.000Z (over 6 years ago)
- Last Synced: 2024-11-16T15:46:02.703Z (6 months ago)
- Language: JavaScript
- Size: 80.1 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# AWS CloudFormation Deployment
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:
```sh
$ yarn global add @joblocal/aws-cfn-deployment
```
Using npm for global usage:
```sh
$ npm install -g @joblocal/aws-cfn-deployment
```
Installing as a local dependency using yarn:
```sh
$ yarn add @joblocal/aws-cfn-deployment
```
Installing as a local dependency using npm:
```sh
$ 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](https://aws.amazon.com/de/cli/).
After installing `aws-cfn-deployment` you can use it as follows.
```sh
$ 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):
```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:
```sh
$ aws-cfn-deployment
--region $AWS_DEFAULT_REGION
--stackName MyBucket
--templatePath bucket.yaml
--BucketName AwesomeBucket
```
## Built with
* [Yarn](https://yarnpkg.com/lang/en/) - Dependency Management
* [Jest](https://facebook.github.io/jest/) - Test Runner
## Contributing
Please read through our [contributing guidelines](https://github.com/joblocal/aws-cfn-deployment/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and feature requests.
## Authors
* **Joblocal GmbH** - *Initial work* - [Joblocal](https://github.com/joblocal)
See also the list of [contributors](https://github.com/joblocal/aws-cfn-deployment/contributors) who participated in this project.