Code Monkey home page Code Monkey logo

node-aws-utils's Introduction

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.
npm npm

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):

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

node-aws-utils's People

Contributors

beverts312 avatar

Watchers

 avatar

node-aws-utils's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.