aws-eb-health

aws-eb-health

Get the AWS Elastic Beanstalk health color and status

Install

npm i --save aws-eb-health

Usage

const awsEbHealth = require('aws-eb-health');

const environmentId = 'a-403cazdnim';

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

awsEbc(environmentId, credentials).then(response => {
    console.log(response.color); // Green
    console.log(response.healthStatus); // Ok
});

API

awsEbHealth(identifier, applicationName, credentials)

Resolve a Promise with an object.

identifier

Type: string

You can use the canonical name or environment id.

OBS: If you use canonical name is required to pass applicationName.

applicationName

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