aws-mgmt-utils

Node AWS Utils

Wrapper methods & scripts for easy use of the AWS SDK.
The aws-sdk is great in terms of completeness, but it typically takes a chain of a few methods to complete most simple tasks, this library aims to make it a little easier to perform specific tasks.

I will add more features as I need them for other projects.
Feel free to request new features with an issue or to submit new features with a PR.

Usage

Configure using the aws-sdk instructions.

Install: npm install --save aws-mgmt-utils
Import: import utils = require('aws-mgmt-utils');

CloudFormation

Initialize the class: const cloudFormation = new utils.CloudFormation(opts);, it takes these options, this param is optional.

• createOrUpdateStackUrl(name: string, templateUrl: string): Promise - This method can be used to create or update a stack using a template hosted in S3. Waits for create/update to complete.
• createOrUpdateStackFile(name: string, templatePath: string): Promise - This method can be used to create or update a stack using a local template. Waits for create/update to complete.
• checkIfStackExists(name: string): Promise<boolean> - This method can be used to determine whether or not a stack exists.

Route53

Initialize the class: const route53 = new utils.Route53(opts);, it takes these options, this param is optional.

• getHostedZoneId(name: string): Promise<string> - This method can be used to retrieve a hosted zone ID
• updateRecord(name: string, type: string, value: string): Promise - This method can be used to update a DNS record

S3

Initialize the class: const s3 = new utils.S3(opts);, it takes these options, this param is optional.

• uploadToS3(toUpload: string, bucket: string, acl: string, prefix?: string): Promise - Uploads a file or folder to S3

Example Scripts

Script	Description
update-record.ts	This script can be used to easily update Route53 DNS records
route53-on-o365.ts	This script can be used to configure a Route53 hosted zone with O365
upload-dir.ts	This script can be used to upload a file or folder to S3

CLI

The example scripts are configured to be accessable if you install this package globally (npm install -g aws-mgmt-utils).
The available executables are (type them into the command line to see usage):

• r53-update-record: Maps to update-record.ts
• s3-upload-dir: Maps to upload-dir.ts
• r53-o365: Maps to route53-on-o365.ts

Developing

This library is written using typescript.
All core developer functions are npm scripts:

• npm install - Get typings and packages
• npm run build - Transpile
• npm run test - Run unit tests
• npm run clean - Remove transpiled javascript

The files in the .vscode directory configure the VS Code Editor for use with this project.
If you use VS Code I would reccomend the Status Bar Tasks extension, this will make all of those core developer tasks (and more) buttons on the bottom of your editor.

Generator

Initially created by this swell generator