Yeoman generators for lambda-tools
npm install generator-lambda-tools
This repository contains Yeoman generators for lambda-tools package. The provided generators help set up a new service, as well as add functionality to an existing service.
Make sure to have yo installed:
``bash`
npm install -g yo
Then install the generators:
`bash`
npm install generator-lambda-tools -g
As with any Yeoman generator, the instructions given above are how to start the generator, which will guide you through the process by prompting for various answers. It is important to emphasise, that all of the subgenerators assume an existing service is in place (meaning a cf.json and api.json files already exist).
* lambda-tools
* lambda-tools:lambda
* lambda-tools:periodic-lambda
* lambda-tools:endpoint
* lambda-tools:endpoint-response
* lambda-tools:endpoint-cors
* lambda-tools:dynamo-table
* lambda-tools:dynamo-index
* lambda-tools:dynamo-stream
Setting up a new service is easy, just run the main generator. The generator will set up the main directory structure of the service, as well as setting up a yo config file. The generator creates stubs of cf.json, api.json and a directory called lambdas.
`bash`
yo lambda-tools
The generator does assume that the npm package has already been set up via npm init. The generator will also, optionally, install dependencies to the current node package. Currently, the two dependencies that are offered are lambda-tools and lambda-foundation. If the first is installed, the service also configures an appropriate start script for the package (if one doesn't already exist).
Not all Lambda functions need to be exposed via the API Gateway, creating such a Lambda function can be done by calling the lambda subgenerator:
`bash`
yo lambda-tools:lambda
The generator creates a Lambda function in under the lambdas directory, along with , which can be used by lambda-tools via the lambda execute command in the newly created subdirectory.
Often there is a demand for a Lambda function that would run on a schedule, whether absolute or at a preset rate. Such Lambda functions can be created by calling the periodic-lambda subgenerator:
`bash`
yo lambda-tools:periodic-lambda
The generator creates a Lambda function in under the lambdas directory, along with an optional event file as well as all of the CloudFormation resources in cf.json that are required for periodic execution.
Adding an API Gateway endpoint that is backed by a Lambda function can be done via the endpoint subgenerator:
`bash`
yo lambda-tools:endpoint
The endpoint generator supports all HTTP methods supported by API Gateway, as well as primitive mapping of integration headers to request headers to Lambda event properties.
Currently, the generator does not specifically support responses or their templates. These will need to be added manually as needed to api.json (default 200 OK responses are added by default).
Adding a new response (status code) to an endpoint in API Gateway can be done with the endpoint-response subgenerator:
`bash`
yo lambda-tools:endpoint-response
This generator offers adding a new response (such as a 404 or a 400) to an existing endpoint/HTTP method combination. The generator also covers response mapping templates and parameters (headers). The end result of the generator is a modified api.json file, with necessary lines added to support the new response type. These responses can be used by returning an error from the Lambda function, as currently API Gateway does not support multiple response types for successful responses.
Once a path has been fully implemented with all of its HTTP methods/endpoints, you can add CORS support to it with the endpoint-cors generator.
`bash`
yo lambda-tools:endpoint-cors
The generator will make sure the path has the appropriate OPTIONS method defined as well as making sure all other methods/responses include suitable CORS headers.
_Note: Currently the Access-Control-Allow-Headers header is not optimised, meaning if there are headers that are unique to a specific method on a path, then the headers they have defined will be added to the CORS headers of all other methods on said path as well. Generally this is not a problem, but it may expose more headers than would be ideal._
Services often include a DynamoDB table, which can be quickly set up using the dynamo-table subgenerator. The generator creates the appropriate entry into cf.json. Furthermore, there's also a dynamo-index subgenerator, which allows adding new global/local secondary indices to DynamoDB resources in the service.
Currently, the generator does not allow modifying the throughput options on the table or indices. The generator also assumes that the base cf.json was created via yo lambda-tools. Furthermore
`bash`
yo lambda-tools:dynamo-table
yo lambda-tools:dynamo-index
DynamoDB tables expose a stream, which allows triggering Lambda functions when a change is conducted on the table (such as adding or removing a row). Enabling the stream and adding a Lambda function to handle the changes can be done via the dynamo-stream generator.
`bash`
yo lambda-tools:dynamo-stream
The generator will add an appropriate event source mapping to cf.json, as well as make sure that lambda_policies.json` has appropriate policy set for the table.