starhs-api-proxy-aws-lambda

1.19.2 • Public • Published

starhs-api-proxy-aws-lambda

Build Status monitored by greenkeeper.io js-standard-style semantic-release Test Coverage Code Climate

NPM

A proxy for the staRHs API running on AWS lambda.

Live

🌍 https://65isx1vpxe.execute-api.eu-central-1.amazonaws.com/prod

This API is hosted as the staRHsAPIproxy AWS Lambda function and the HTTP endpoint is provided via the staRHsAPI@prod API Gateway stage.

The Lambda function uses the role staRHsAPI.

These environment variables have been configured on the Lamba:

  • MOUNT_URL=https://65isx1vpxe.execute-api.eu-central-1.amazonaws.com/prod
    This informations is needed for creating links to the services endpoints.
  • STARHSAPI__KEY=*****
    API key to use, when connecting to the staRHs REST API
  • STARHSAPI__PASSWORD=*****
    Password to use, when connecting to the staRHs REST API
  • STARHSAPI__USER=staRHsWebApp
    Username to use, when connecting to the staRHs REST API

Connected Services

The proxy connects to the staRHs REST API provided by Digital Bauhaus.

The credentials for the REST API are provided by Digital Bauhaus.

Deployment

🚀 Deployment for this package is automated via Travis CI.
Every commit can potentially trigger a deploy.

If lint and test ran without error, semantic-release will be used to determine the next version for the package and that version string will be written to the package.json. After semantic-release has been run, make update will be executed to deploy a new release.

If a new version has been released by semantic-release, make update will update the Lambda code. It uses these environment variables (which are provided via Travis):

  • AWS_ACCESS_KEY_ID
    The AWS access key to use
  • AWS_SECRET_ACCESS_KEY
    The AWS secret access key to use

The AWS credentials for Travis are taken from the starhs@deploy user.

You can create new AWS keys via IAM. Assign the new user to the group staRHs which has the neccessary permission to update Lambda function.

Readme

Keywords

Package Sidebar

Install

npm i starhs-api-proxy-aws-lambda

Weekly Downloads

2

Version

1.19.2

License

MIT

Last publish

Collaborators

  • resourcefuldevelopers
  • dam1r89