node package manager

lambda-instant

lambda-instant

Given a javascript function and a relative path, deploy to AWS Lambda and attach to an endpoint with AWS API Gateway.

Circle CI

Usage

lambda-instant was designed with a common use-case in mind: deploying one or more lambda functions to URLs with arbitrary relative paths (e.g. /foo, /foo/bar), such that they can be executed with a POST. For example:

 
require('lambda-instant').createAPI({},
  'LambdaInstantTests',
  'foo/bar/baz',
  zip
).then(console.log)

The first argument is a dictionary of optional parameters used to override defaults used in Gateway and Lambda API calls (see below). The second argument is the name of the Gateway API to which the function is to be deployed. The third argument is the relative path at which the function will be accessible. The third argument (zip) is a nodebuffer of a zip file containing index.js, which file must export a function named handler which will be called with the POST body and information about the runtime environment (see AWS documentation for details). Consult test/lib/trivialzip.js for an example of how such a zip may be created.

If the API endpoint creation is successful, this function will return a promise for its URL (e.g. https://kr4rfm1cc9.execute-api.us-east-1.amazonaws.com/prod/foo/bar/baz). Note that the resolution of the promise does not guarantee that the API is ready to be called; it may take several seconds (no more than 10) for the necessary resources to come online.

Configuration

Required environment variables:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • INSTANT_LAMBDA_ROLE: The ARN of the role that will be used to create the lambda function which "Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources" (e.g. arn:aws:iam::396739148201:role/lambda_basic_execution)
  • INSTANT_GATEWAY_ROLE: The ARN of the "IAM Role for Amazon API Gateway to assume" (e.g. arn:aws:iam::396739148201:role/lambda_instant_executor)

Optionally:

  • AWS_REGION: The region to which the lambda function will be deployed.