@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.
ParcelBaseOptions	Base options for Parcel bundling.
ParcelOptions	Options for Parcel bundling.

Class Summary

Class	Description
Bundling	Bundling.
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
ParcelBaseOptions.Builder	A builder for ParcelBaseOptions
ParcelBaseOptions.Jsii$Proxy	An implementation for ParcelBaseOptions
ParcelOptions.Builder	A builder for ParcelOptions
ParcelOptions.Jsii$Proxy	An implementation for ParcelOptions

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")// accepts .js, .jsx, .ts and .tsx files
         .handler("myExportedFunc")
         .build();
 

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

The NodejsFunction construct automatically reuses existing connections when working with the AWS SDK for JavaScript. Set the awsSdkConnectionReuse prop to false to disable it.

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();
 

Use the buildArgs prop to pass build arguments when building the bundling image:

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

Configuring Parcel

The NodejsFunction construct exposes some Parcel options via properties: minify, sourceMaps 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.

Working with modules

Externals

By default, all node modules are bundled except for aws-sdk. This can be configured by specifying the externalModules prop.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 NodejsFunction.Builder.create(this, "my-handler")
         .externalModules(asList("aws-sdk", "cool-module"))
         .build();
 

Install modules

By default, all node modules referenced in your Lambda code will be bundled by Parcel. Use the nodeModules prop to specify a list of modules that should not be bundled but instead included in the node_modules folder of the Lambda package. This is useful when working with native dependencies or when Parcel fails to bundle a module.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 NodejsFunction.Builder.create(this, "my-handler")
         .nodeModules(asList("native-module", "other-module"))
         .build();
 

The modules listed in nodeModules must be present in the package.json's dependencies. The same version will be used for installation. If a lock file is detected (package-lock.json or yarn.lock) it will be used along with the right installer (npm or yarn). The modules are installed in a Lambda compatible Docker container.