gulp-elastic-beanstalk-deploy/README.md

A Gulp module for deploying to AWS Elastic Beanstalk

gulp-elastic-beanstalk-deploy
=====

> A Gulp module for deploying to AWS Elastic Beanstalk

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

_Based on [gulp-beanstalk-deploy](https://github.com/a0ly/gulp-beanstalk-deploy) by SeungJae Lee._

## Getting Started

You can install plugin by this command:

```shell
$ npm install gulp-elastic-beanstalk-deploy
```

## Overview

```javascript
gulp.task('deploy', function(cb) {
    eb({
        // options here
    }, cb)
});
```

### Options

A * indicates a mandatory option.

##### profile

* Type: `string`

The AWS profile to use. This refers to an IAM user with credentials in the `~/.aws/credentials` file.

##### accessKeyId

* Type: `string`
* Default: `~/.aws/credentials`

The AWS access key id. If nothing is passed, it will use your local AWS profile credential.

##### secretAccessKey

* Type: `string`
* Default: `~/.aws/credentials`

The AWS access secret access key. If nothing is passed, 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 enviroment 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:
```javascript
{
    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.

##### uploadOnly
* Type: `boolean`
* Default: false

Used if you want to upload a package to the application without deploying to an environment. 

## Usage Example
``` javascript
const gulp = require('gulp');
const eb = require('gulp-elastic-beanstalk-deploy');

gulp.task('deploy', function(cb) {
    eb({
        profile: 'YOUR-IAM-USER', // optional
        accessKeyId: 'YOUR-AWS-ACCESS-KEY-ID', // optional
        secretAccessKey: 'YOUR-AWS-SECRET-ACCESS-KEY', // optional
        region: 'YOUR-REGION', // required
        applicationName:'my-eb-app',
        environmentName: 'my-eb-env',
        versionLabel: '1.0.0',
        sourceBundle: './archive.zip',
        description: 'Description here'
    }, cb);
});
```

## License
MIT