interface BundlingOptions

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.Nodejs.BundlingOptions
Java	software.amazon.awscdk.services.lambda.nodejs.BundlingOptions
Python	aws_cdk.aws_lambda_nodejs.BundlingOptions
TypeScript (source)	@aws-cdk/aws-lambda-nodejs » BundlingOptions

Bundling options.

Example

new lambda.NodejsFunction(this, 'my-handler', {
  bundling: {
    dockerImage: DockerImage.fromBuild('/path/to/Dockerfile'),
  },
});

Properties

Name	Type	Description
assetHash?	string	Specify a custom hash for this asset.
banner?	string	Use this to insert an arbitrary string at the beginning of generated JavaScript files.
buildArgs?	{ [string]: string }	Build arguments to pass when building the bundling image.
charset?	Charset	The charset to use for esbuild's output.
commandHooks?	ICommandHooks	Command hooks.
define?	{ [string]: string }	Replace global identifiers with constant expressions.
dockerImage?	DockerImage	A custom bundling Docker image.
environment?	{ [string]: string }	Environment variables defined when bundling runs.
esbuildArgs?	{ [string]: string | boolean }	Build arguments to pass into esbuild.
esbuildVersion?	string	The version of esbuild to use when running in a Docker container.
externalModules?	string[]	A list of modules that should be considered as externals (already available in the runtime).
footer?	string	Use this to insert an arbitrary string at the end of generated JavaScript files.
forceDockerBundling?	boolean	Force bundling in a Docker container even if local bundling is possible.
format?	OutputFormat	Output format for the generated JavaScript files.
inject?	string[]	This option allows you to automatically replace a global variable with an import from another file.
keepNames?	boolean	Whether to preserve the original name values even in minified code.
loader?	{ [string]: string }	Use loaders to change how a given input file is interpreted.
logLevel?	LogLevel	Log level for esbuild.
mainFields?	string[]	How to determine the entry point for modules.
metafile?	boolean	This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.
minify?	boolean	Whether to minify files when bundling.
nodeModules?	string[]	A list of modules that should be installed instead of bundled.
preCompilation?	boolean	Run compilation using tsc before running file through bundling step.
sourceMap?	boolean	Whether to include source maps when bundling.
sourceMapMode?	SourceMapMode	Source map mode to be used when bundling.
sourcesContent?	boolean	Whether to include original source code in source maps when bundling.
target?	string	Target environment for the generated JavaScript code.
tsconfig?	string	Normally the esbuild automatically discovers tsconfig.json files and reads their contents during a build.

---

assetHash?

Type: string (optional, default: asset hash is calculated based on the bundled output)

Specify a custom hash for this asset.

For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash.

NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. 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.

---

banner?

Type: string (optional, default: no comments are passed)

Use this to insert an arbitrary string at the beginning of generated JavaScript files.

This is similar to footer which inserts at the end instead of the beginning.

This is commonly used to insert comments:

---

buildArgs?

Type: { [string]: string } (optional, default: no build arguments are passed)

Build arguments to pass when building the bundling image.

---

charset?

Type: Charset (optional, default: Charset.ASCII)

The charset to use for esbuild's output.

By default esbuild's output is ASCII-only. Any non-ASCII characters are escaped using backslash escape sequences. Using escape sequences makes the generated output slightly bigger, and also makes it harder to read. If you would like for esbuild to print the original characters without using escape sequences, use Charset.UTF8.

See also: https://esbuild.github.io/api/#charset

---

commandHooks?

Type: ICommandHooks (optional, default: do not run additional commands)

Command hooks.

---

define?

Type: { [string]: string } (optional, default: no replacements are made)

Replace global identifiers with constant expressions.

For example, { 'process.env.DEBUG': 'true' }.

Another example, { 'process.env.API_KEY': JSON.stringify('xxx-xxxx-xxx') }.

---

dockerImage?

Type: DockerImage (optional, default: use the Docker image provided by)

A custom bundling Docker image.

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

See https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-lambda-nodejs/lib/Dockerfile for the default image provided by @aws-cdk/aws-lambda-nodejs.

---

environment?

Type: { [string]: string } (optional, default: no environment variables are defined.)

Environment variables defined when bundling runs.

---

esbuildArgs?

Type: { [string]: string | boolean } (optional, default: no additional esbuild arguments are passed)

Build arguments to pass into esbuild.

For example, to add the --log-limit flag:

new NodejsFunction(scope, id, {
   ...
   bundling: {
     esbuildArgs: {
       "--log-limit": "0",
     }
   }
});

---

esbuildVersion?

Type: string (optional, default: latest v0)

The version of esbuild to use when running in a Docker container.

---

externalModules?

Type: string[] (optional, default: ['aws-sdk'])

A list of modules that should be considered as externals (already available in the runtime).

---

footer?

Type: string (optional, default: no comments are passed)

Use this to insert an arbitrary string at the end of generated JavaScript files.

This is similar to banner which inserts at the beginning instead of the end.

This is commonly used to insert comments

---

forceDockerBundling?

Type: boolean (optional, default: false)

Force bundling in a Docker container even if local bundling is possible.

This is useful if your function relies on node modules that should be installed (nodeModules) in a Lambda compatible environment.

---

format?

Type: OutputFormat (optional, default: OutputFormat.CJS)

Output format for the generated JavaScript files.

---

inject?

Type: string[] (optional, default: no code is injected)

This option allows you to automatically replace a global variable with an import from another file.

See also: https://esbuild.github.io/api/#inject

---

keepNames?

Type: boolean (optional, default: false)

Whether to preserve the original name values even in minified code.

In JavaScript the name property on functions and classes defaults to a nearby identifier in the source code.

However, minification renames symbols to reduce code size and bundling sometimes need to rename symbols to avoid collisions. That changes value of the name property for many of these cases. This is usually fine because the name property is normally only used for debugging. However, some frameworks rely on the name property for registration and binding purposes. If this is the case, you can enable this option to preserve the original name values even in minified code.

---

loader?

Type: { [string]: string } (optional, default: use esbuild default loaders)

Use loaders to change how a given input file is interpreted.

Configuring a loader for a given file type lets you load that file type with an import statement or a require call.

See also: [https://esbuild.github.io/api/#loader

For example, { '.png': 'dataurl' }.](https://esbuild.github.io/api/#loader

For example, { '.png': 'dataurl' }.)

---

logLevel?

Type: LogLevel (optional, default: LogLevel.WARNING)

Log level for esbuild.

This is also propagated to the package manager and applies to its specific install command.

---

mainFields?

Type: string[] (optional, default: ['main', 'module'])

How to determine the entry point for modules.

Try ['module', 'main'] to default to ES module versions.

---

metafile?

Type: boolean (optional, default: false)

This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.

The metadata in this JSON file follows this schema (specified using TypeScript syntax):

{
   outputs: {
     [path: string]: {
       bytes: number
       inputs: {
         [path: string]: { bytesInOutput: number }
       }
       imports: { path: string }[]
       exports: string[]
     }
   }
}

This data can then be analyzed by other tools. For example, bundle buddy can consume esbuild's metadata format and generates a treemap visualization of the modules in your bundle and how much space each one takes up.

See also: https://esbuild.github.io/api/#metafile

---

minify?

Type: boolean (optional, default: false)

Whether to minify files when bundling.

---

nodeModules?

Type: string[] (optional, default: all modules are bundled)

A list of modules that should be installed instead of bundled.

Modules are installed in a Lambda compatible environment only when bundling runs in Docker.

---

preCompilation?

Type: boolean (optional, default: false)

Run compilation using tsc before running file through bundling step.

This usually is not required unless you are using new experimental features that are only supported by typescript's tsc compiler. One example of such feature is emitDecoratorMetadata.

---

sourceMap?

Type: boolean (optional, default: false)

Whether to include source maps when bundling.

---

sourceMapMode?

Type: SourceMapMode (optional, default: SourceMapMode.DEFAULT)

Source map mode to be used when bundling.

See also: https://esbuild.github.io/api/#sourcemap

---

sourcesContent?

Type: boolean (optional, default: true)

Whether to include original source code in source maps when bundling.

See also: https://esbuild.github.io/api/#sources-content

---

target?

Type: string (optional, default: the node version of the runtime)

Target environment for the generated JavaScript code.

See also: https://esbuild.github.io/api/#target

---

tsconfig?

Type: string (optional, default: automatically discovered by esbuild)

Normally the esbuild automatically discovers tsconfig.json files and reads their contents during a build.

However, you can also configure a custom tsconfig.json file to use instead.

This is similar to entry path, you need to provide path to your custom tsconfig.json.

This can be useful if you need to do multiple builds of the same code with different settings.

For example, { 'tsconfig': 'path/custom.tsconfig.json' }.