gulp-awsebtdeploy

A gulp plugin for deployment your application to AWS Elastic Beanstalk

This plugin helps you to integrate your deployment task on the Amazon AWS Elasticbeanstalk service into gulp. Your deployment job will be more mainatainable and efficient, so that you can increase productivity.

Forked from https://github.com/a0ly/gulp-beanstalk-deploy.

Getting Started

You can install plugin by this command:

npm install gulp-awsebtdeploy

Overview

const eb = require('gulp-awsebtdeploy')
 
gulp.task('deploy', function() {
  return eb({
    // options here
  })
});

The task returns a promise that resolves when the target environment's status becomes Ready.

Options

A * indicates a mandatory option.

accessKeyId

• Type: string
• Default: ~/.aws/credentials

The aws access key id. If nothing passwed, it will use your local aws profile credential.

secretAccessKey

• Type: string
• Default: ~/.aws/credentials

The aws access secret access key. If nothing passwed, it will use your local aws profile credential.

region *

• Type: string

Your application region. It must be provided.

applicationName *

• Type: string

Your application name. It must be provided.

environmentName *

• Type: string

Your application environment name. It must be provided.

versionLabel

• Type: string
• Default: sourceBundle file name without the extension

description

• Type: string

Your deployment description.

settings

• Type: Array

Your environment setting parameters.

waitForDeploy

• Type: boolean
• Default: true

checkIntervalSec

• Type: number
• Default: 2sec

Interval time to check deploying status. (sec)

s3Bucket

• Type: object
• Default:

{
    bucket: // applicationName
    key: // sourceBundle basename
}

sourceBundle *

• Type: string

archive file path to upload. It must exists in your local file system, which means the archive file must be prepared before deployment task.

proxy

• Type: string
• Default: none

Optional proxy url to use for requests.

Usage Example

var gulp = require('gulp');
var eb = require('gulp-awsebtdeploy');
 
gulp.task('deploy', function() {
  eb({
    accessKeyId: 'Your AWS accessKeyId', // optional
    secretAccessKey: 'Your AWS secretAccessKey', // optional
    region: 'us-west-1', // required
    applicationName:'gulp-beanstalk-deploy',
    environmentName: 'gulp-beanstalk-deploy-env',
    versionLabel: '1.0.0',
    sourceBundle: './archive.zip',
    description: 'description here'
  });
});

License

MIT