aws-ebc

Describe details of an environment at Elastic Beanstalk by their URL

Usage no npm install needed!

<script type="module">
  import awsEbc from 'https://cdn.skypack.dev/aws-ebc';
</script>

README

aws-ebc Build Status Dependency Status Npm Package Version

Describe details of an environment at Elastic Beanstalk by their URL

Why?

If you use Blue Green Deployment with Elastic Beanstalk, know that there is no fixed id of environments. Through the Swap Url's you make the switch the URL of environments.

So you can assume that the only fixed reference is the URL of your environment. However, the SDK of AWS does not Provide an API where you find in this way.

And this package solve this problem.

Install

npm i --save aws-ebc

Usage

const awsEbc = require('aws-ebc');

const url = 'my-application.us-east-1.elasticbeanstalk.com';
const appName = 'my-application';

const credentials = {
    region: 'us-east-1',
    accessKeyId: 'ACCESSKEYID',
    secretAccessKey: 'SECRETACCESSKEY'
};

awsEbc(url, appName, credentials).then(environment => {
    console.log(environment.id) // aq14fG1a-1
    console.log(environment.name) // example
    console.log(environment.health) // Green
    console.log(environment.status) // Ready
});

API

awsEbc(url, appName, credentials)

Return an object with id, name, health and status of the environment.

url

Type: string

URL of the environment you're searching.

appName

Type: string

The application name of the environment.

credentials.region

Type: string

The region that their environment is available.

credentials.accessKeyId

Type: string

Acces Key Id offered by AWS Identity and Access Management (IAM)

credentials.secretAccessKey

Type: string

Secret Access Key offered by AWS Identity and Access Management (IAM)

License

MIT © Cauê Alves