gulp-elb-deploy

Gulp plugin for deploying AWS Elastic Beanstalk applications

Disclaimer

This is inspired by this other projects gulp-beanstalk-deploy by SeungJae Lee and gulp-elasticbeanstalk-deploy by Juan José Herrero Barbosa.

A plugin devloped in Typescript that helps you deploy your applications to AWS Elastic Beanstalk services easily using Gulp.

Installation

You can install this plugin by running this command on the terminal

$ npm install gulp-elb-deploy

Usage Example

import gulp from "gulp",
import  eb_deploy from "gulp-elb-deploy";

gulp.task("deploy", function () {
  return gulp
    .src(["<application-directory-path>"], {
      base: "./",
      nodir: true,
    })
    .pipe(
      eb_deploy({
        version: "APPLICATION_VERSION",
        timestamp: true,
        waitForDeploy: true,
        accessKeyId: "AWS_ACCESS_KEY",
        secretAccessKey: "AWS_SECRET_KEY",
        signatureVersion: "AWS_ENVIRONMENT_VERSION",
        region: "AWS_ENVIRONMENT_REGION",
        bucket: "AWS_ENVIRONMENT_S3_BUCKET",
        applicationName: "AWS_ELASTIC_BEANSTALK_APPLICATION_NAME",
        environmentName: "AWS_ELASTIC_BEANSTALK_ENVIRONMENT_NAME",
      })
    );
});

Options

version

• Type: string
• Default: package.json version

The version that will be used on the filename for the .zip file

timestamp

• Type: string
• Default: false

Determine whether the filename will contain a time and date

waitForDeploy

• Type: string
• Default: false

Determine whether to wait for the upload to finish

accessKeyId

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

The access key provided by AWS associated with the IAM user or AWS account. How do I create an AWS access key?.

secretAccessKey

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

The secret key provided by AWS associated with the IAM user or AWS account. How do I create an AWS scret key?.

signatureVersion

• Type: string
• Default: v4

Version of AWS requests

region

• Type: string
• Required

AWS application region. See AWS service endpoints.

applicationName

• Type: string
• Required

The name of an AWS application associated with the IAM user or AWS account. See AWS application name

environmentName

• Type: string
• Required

The name of an AWS environment associated with your application. See AWS CreateEnvironment

bucket

• Type: string
• Required

The name of an AWS S3 bucket associated with your Elastic Beanstalk. See Elastic Beanstalk with Amazon S3

License

MIT

Contributor

Mark Anthony Ignacio