starter-aws

NodeJS module for AWS instances easy management : start/stop/reboot

npm install starter-aws
10 downloads in the last week
18 downloads in the last month

StarterAWS NPM version Build Status Total views

StarterAWS NodeJS module for AWS instances easy management : start/stop/reboot.

Why ?

Because ecchymose in the nose.

Tired of checking frenquently my AWS instances status, I will soon combined it with one angular directive to make it available in your administration UI.

But first can be used at your node application startup, and force a clean start of your AWS instances if needed.

Demo

http://darul-demo.herokuapp.com/starter

Install

npm install starter-aws

Usage

Command line

node starter-aws.js <AWS-accessKeyId> <AWS-secretAccessKey> <AWS-region> <AWS-instancesId> <state>

Application

var starterAws = require('starter-aws');

// API INIT CREDENTIALS
starterAws.initCredentials({
    'accessKeyId': '',
    'secretAccessKey': '',
    'region': '',
    'instancesId' : ''
});

// API START INSTANCE(S)
starterAws.start(function(err, status) {
 // status 'ok' when done 
});

// API STOP INSTANCE(S)
starterAws.stop(function(err, status) {
 // status 'ok' when done 
});

// API REBOOT INSTANCE(S)
starterAws.reboot(function(err, status) {
 // status 'ok' when done 
});

// API STARTING DAEMON INSTANCE(S) status
starterAws.daemon(function(err, status) {
 // status 'ok' when done 
});

// API GET INSTANCE(S) STATUS
starterAws.status(function(err, status) {

// status my return:
/*[ { InstanceId: 'i-53613f18',
    ImageId: 'ami-c37474b7',
    InstanceType: 't1.micro',
    State: 'stopped' },
  { InstanceId: 'i-98f372d2',
    ImageId: 'ami-3c5f5748',
    InstanceType: 't1.micro',
    State: 'stopped' } ]
  */  
});

Options

  • accessKeyId AWS accessKeyId
  • secretAccessKey AWS secretAccessKey
  • region AWS region
  • instancesId AWS instance(s) id, ',' separtor if multi, example: i-53613f50,i-53613f30,i-53613f20
  • state string state to force, enum values are 'start', 'stop', 'reboot'

Return

status

  • ok job is done

err

  • many most of time parameters order or missing, easy to figure what is wrong.

License

The MIT License (MIT)

Copyright (c) 2013 Julien Valéry

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you