@Stability(value=Experimental)

Package software.amazon.awscdk.services.lambda.nodejs

Amazon Lambda Node.js Library

See: Description

Interface Summary

Interface	Description
NodejsFunctionProps	Properties for a NodejsFunction.

Class Summary

Class	Description
NodejsFunction	A Node.js Lambda function bundled using Parcel.
NodejsFunction.Builder	A fluent builder for NodejsFunction.
NodejsFunctionProps.Builder	A builder for NodejsFunctionProps
NodejsFunctionProps.Jsii$Proxy	An implementation for NodejsFunctionProps

Package software.amazon.awscdk.services.lambda.nodejs Description

Amazon Lambda Node.js Library

---

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

This library provides constructs for Node.js Lambda functions.

To use this module, you will need to have Docker installed.

Node.js Function

Define a NodejsFunction:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 new NodejsFunction(this, "my-handler");
 

By default, the construct will use the name of the defining file and the construct's id to look up the entry file:

 .
 ├── stack.ts # defines a 'NodejsFunction' with 'my-handler' as id
 ├── stack.my-handler.ts # exports a function named 'handler'
 

This file is used as "entry" for Parcel. This means that your code is automatically transpiled and bundled whether it's written in JavaScript or TypeScript.

Alternatively, an entry file and handler can be specified:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 NodejsFunction.Builder.create(this, "MyFunction")
         .entry("/path/to/my/file.ts")
         .handler("myExportedFunc")
         .build();
 

All other properties of lambda.Function are supported, see also the AWS Lambda construct library.

Use the containerEnvironment prop to pass environments variables to the Docker container running Parcel:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 NodejsFunction.Builder.create(this, "my-handler")
         .containerEnvironment(Map.of(
                 "NODE_ENV", "production"))
         .build();
 

Configuring Parcel

The NodejsFunction construct exposes some Parcel options via properties: minify, sourceMaps, buildDir and cacheDir.

Parcel transpiles your code (every internal module) with @babel/preset-env and uses the runtime version of your Lambda function as target.

Configuring Babel with Parcel is possible via a .babelrc or a babel config in package.json.