Skip navigation links

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

Amazon Lambda Node.js Library

See: Description

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

Amazon Lambda Node.js Library

---

cdk-constructs: Stable


This library provides constructs for Node.js Lambda functions.

Node.js Function

The NodejsFunction construct creates a Lambda function with automatic transpiling and bundling of TypeScript or Javascript code. This results in smaller Lambda packages that contain only the code and dependencies needed to run the function.

It uses esbuild under the hood.

Reference project architecture

The NodejsFunction allows you to define your CDK and runtime dependencies in a single package.json and to collocate your runtime code with your infrastructure code:

 .
 ├── lib
 │   ├── my-construct.api.ts # Lambda handler for API
 │   ├── my-construct.auth.ts # Lambda handler for Auth
 │   └── my-construct.ts # CDK construct with two Lambda functions
 ├── package-lock.json # single lock file
 ├── package.json # CDK and runtime dependencies defined in a single package.json
 └── tsconfig.json
 

By default, the construct will use the name of the defining file and the construct's id to look up the entry file. In my-construct.ts above we have:

 // automatic entry look up
 NodejsFunction apiHandler = new NodejsFunction(this, "api");
 NodejsFunction authHandler = new NodejsFunction(this, "auth");
 

Alternatively, an entry file and handler can be specified:

 NodejsFunction.Builder.create(this, "MyFunction")
         .entry("/path/to/my/file.ts") // accepts .js, .jsx, .ts and .tsx files
         .handler("myExportedFunc")
         .build();
 

For monorepos, the reference architecture becomes:

 .
 ├── packages
 │   ├── cool-package
 │   │   ├── lib
 │   │   │   ├── cool-construct.api.ts
 │   │   │   ├── cool-construct.auth.ts
 │   │   │   └── cool-construct.ts
 │   │   ├── package.json # CDK and runtime dependencies for cool-package
 │   │   └── tsconfig.json
 │   └── super-package
 │       ├── lib
 │       │   ├── super-construct.handler.ts
 │       │   └── super-construct.ts
 │       ├── package.json # CDK and runtime dependencies for super-package
 │       └── tsconfig.json
 ├── package-lock.json # single lock file
 ├── package.json # root dependencies
 └── tsconfig.json
 

Customizing the underlying Lambda function

All properties of lambda.Function can be used to customize the underlying lambda.Function.

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.

Lock file

The NodejsFunction requires a dependencies lock file (yarn.lock, pnpm-lock.yaml or package-lock.json). When bundling in a Docker container, the path containing this lock file is used as the source (/asset-input) for the volume mounted in the container.

By default, the construct will try to automatically determine your project lock file. Alternatively, you can specify the depsLockFilePath prop manually. In this case you need to ensure that this path includes entry and any module/dependencies used by your function. Otherwise bundling will fail.

Local bundling

If esbuild is available it will be used to bundle your code in your environment. Otherwise, bundling will happen in a Lambda compatible Docker container with the Docker platform based on the target architecture of the Lambda function.

For macOS the recommendend approach is to install esbuild as Docker volume performance is really poor.

esbuild can be installed with:

 $ npm install --save-dev esbuild@0
 

OR

 $ yarn add --dev esbuild@0
 

To force bundling in a Docker container even if esbuild is available in your environment, set bundling.forceDockerBundling to true. This is useful if your function relies on node modules that should be installed (nodeModules prop, see below) in a Lambda compatible environment. This is usually the case with modules using native dependencies.

Working with modules

Externals

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

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .externalModules(List.of("aws-sdk", "cool-module"))
                 .build())
         .build();
 

Install modules

By default, all node modules referenced in your Lambda code will be bundled by esbuild. Use the nodeModules prop under bundling 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 esbuild fails to bundle a module.

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .nodeModules(List.of("native-module", "other-module"))
                 .build())
         .build();
 

The modules listed in nodeModules must be present in the package.json's dependencies or installed. The same version will be used for installation. The lock file (yarn.lock, pnpm-lock.yaml or package-lock.json) will be used along with the right installer (yarn, pnpm or npm).

When working with nodeModules using native dependencies, you might want to force bundling in a Docker container even if esbuild is available in your environment. This can be done by setting bundling.forceDockerBundling to true.

Configuring esbuild

The NodejsFunction construct exposes some esbuild options via properties under bundling:

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .minify(true) // minify code, defaults to false
                 .sourceMap(true) // include source map, defaults to false
                 .sourceMapMode(SourceMapMode.INLINE) // defaults to SourceMapMode.DEFAULT
                 .sourcesContent(false) // do not include original source into source map, defaults to true
                 .target("es2020") // target environment for the generated JavaScript code
                 .loader(Map.of( // Use the 'dataurl' loader for '.png' files
                         ".png", "dataurl"))
                 .define(Map.of( // Replace strings during build time
                         "process.env.API_KEY", JSON.stringify("xxx-xxxx-xxx"),
                         "process.env.PRODUCTION", JSON.stringify(true),
                         "process.env.NUMBER", JSON.stringify(123)))
                 .logLevel(LogLevel.SILENT) // defaults to LogLevel.WARNING
                 .keepNames(true) // defaults to false
                 .tsconfig("custom-tsconfig.json") // use custom-tsconfig.json instead of default,
                 .metafile(true) // include meta file, defaults to false
                 .banner("/* comments */") // requires esbuild >= 0.9.0, defaults to none
                 .footer("/* comments */") // requires esbuild >= 0.9.0, defaults to none
                 .charset(Charset.UTF8)
                 .build())
         .build();
 

Command hooks

It is possible to run additional commands by specifying the commandHooks prop:

 // This example only available in TypeScript
 // Run additional props via `commandHooks`
 new lambda.NodejsFunction(this, 'my-handler-with-commands', {
   bundling: {
     commandHooks: {
       beforeBundling(inputDir: string, outputDir: string): string[] {
         return [
           `echo hello > ${inputDir}/a.txt`,
           `cp ${inputDir}/a.txt ${outputDir}`,
         ];
       },
       afterBundling(inputDir: string, outputDir: string): string[] {
         return [`cp ${inputDir}/b.txt ${outputDir}/txt`];
       },
       beforeInstall() {
         return [];
       },
       // ...
     },
     // ...
   },
 });
 

The following hooks are available:

They all receive the directory containing the lock file (inputDir) and the directory where the bundled asset will be output (outputDir). They must return an array of commands to run. Commands are chained with &&.

The commands will run in the environment in which bundling occurs: inside the container for Docker bundling or on the host OS for local bundling.

Pre Compilation with TSC

In some cases, esbuild may not yet support some newer features of the typescript language, such as, emitDecoratorMetadata. In such cases, it is possible to run pre-compilation using tsc by setting the preCompilation flag.

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .preCompilation(true)
                 .build())
         .build();
 

Note: A tsconfig.json file is required

Customizing Docker bundling

Use bundling.environment to define environments variables when esbuild runs:

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .environment(Map.of(
                         "NODE_ENV", "production"))
                 .build())
         .build();
 

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

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .buildArgs(Map.of(
                         "HTTPS_PROXY", "https://127.0.0.1:3001"))
                 .build())
         .build();
 

Use bundling.dockerImage to use a custom Docker bundling image:

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .dockerImage(DockerImage.fromBuild("/path/to/Dockerfile"))
                 .build())
         .build();
 

This image should have esbuild installed globally. If you plan to use nodeModules it should also have npm, yarn or pnpm depending on the lock file you're using.

Use the default image provided by @aws-cdk/aws-lambda-nodejs as a source of inspiration.

Asset hash

By default the asset hash will be calculated based on the bundled output (AssetHashType.OUTPUT).

Use the assetHash prop to pass a custom hash:

 NodejsFunction.Builder.create(this, "my-handler")
         .bundling(BundlingOptions.builder()
                 .assetHash("my-custom-hash")
                 .build())
         .build();
 

If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated.

Skip navigation links