software.amazon.awscdk.services.lambda.nodejs

Interface BundlingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BundlingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-04-01T03:13:04.979Z")
 @Stability(value=Experimental)
public interface BundlingOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Bundling options.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BundlingOptions.Builder A builder for BundlingOptions
static class	BundlingOptions.Jsii$Proxy An implementation for BundlingOptions

Method Summary

Modifier and Type	Method and Description
static BundlingOptions.Builder	builder()
default String	getBanner() (experimental) Use this to insert an arbitrary string at the beginning of generated JavaScript files.
default Map<String,String>	getBuildArgs() (experimental) Build arguments to pass when building the bundling image.
default ICommandHooks	getCommandHooks() (experimental) Command hooks.
default Map<String,String>	getDefine() (experimental) Replace global identifiers with constant expressions.
default DockerImage	getDockerImage() (experimental) A custom bundling Docker image.
default Map<String,String>	getEnvironment() (experimental) Environment variables defined when bundling runs.
default String	getEsbuildVersion() (experimental) The version of esbuild to use when running in a Docker container.
default List<String>	getExternalModules() (experimental) A list of modules that should be considered as externals (already available in the runtime).
default String	getFooter() (experimental) Use this to insert an arbitrary string at the end of generated JavaScript files.
default Boolean	getForceDockerBundling() (experimental) Force bundling in a Docker container even if local bundling is possible.
default Boolean	getKeepNames() (experimental) Whether to preserve the original `name` values even in minified code.
default Map<String,String>	getLoader() (experimental) Use loaders to change how a given input file is interpreted.
default LogLevel	getLogLevel() (experimental) Log level for esbuild.
default Boolean	getMetafile() (experimental) This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.
default Boolean	getMinify() (experimental) Whether to minify files when bundling.
default List<String>	getNodeModules() (experimental) A list of modules that should be installed instead of bundled.
default Boolean	getSourceMap() (experimental) Whether to include source maps when bundling.
default String	getTarget() (experimental) Target environment for the generated JavaScript code.
default String	getTsconfig() (experimental) Normally the esbuild automatically discovers `tsconfig.json` files and reads their contents during a build.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBanner

@Stability(value=Experimental)
 @Nullable
default String getBanner()

(experimental) 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:

Default: - no comments are passed

getBuildArgs

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getBuildArgs()

(experimental) Build arguments to pass when building the bundling image.

Default: - no build arguments are passed

getCommandHooks

@Stability(value=Experimental)
 @Nullable
default ICommandHooks getCommandHooks()

(experimental) Command hooks.

Default: - do not run additional commands

getDefine

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getDefine()

(experimental) Replace global identifiers with constant expressions.

Default: - no replacements are made

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 {"process.env.API_KEY";JSON.stringify("xxx-xxxx-xxx");
 }

getDockerImage

@Stability(value=Experimental)
 @Nullable
default DockerImage getDockerImage()

(experimental) 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.

Default: - use the Docker image provided by

getEnvironment

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getEnvironment()

(experimental) Environment variables defined when bundling runs.

Default: - no environment variables are defined.

getEsbuildVersion

@Stability(value=Experimental)
 @Nullable
default String getEsbuildVersion()

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

Default: - latest v0

getExternalModules

@Stability(value=Experimental)
 @Nullable
default List<String> getExternalModules()

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

Default: ['aws-sdk']

getFooter

@Stability(value=Experimental)
 @Nullable
default String getFooter()

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

Default: - no comments are passed

getForceDockerBundling

@Stability(value=Experimental)
 @Nullable
default Boolean getForceDockerBundling()

(experimental) 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.

Default: false

getKeepNames

@Stability(value=Experimental)
 @Nullable
default Boolean getKeepNames()

(experimental) 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.

Default: false

getLoader

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getLoader()

(experimental) 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.

Default: - use esbuild default loaders

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 {".png";"dataurl";
 }

See Also:

https://esbuild.github.io/api/#loader

getLogLevel

@Stability(value=Experimental)
 @Nullable
default LogLevel getLogLevel()

(experimental) Log level for esbuild.

Default: LogLevel.WARNING

getMetafile

@Stability(value=Experimental)
 @Nullable
default Boolean getMetafile()

(experimental) 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):

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 {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.

Default: - false

See Also:

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

getMinify

@Stability(value=Experimental)
 @Nullable
default Boolean getMinify()

(experimental) Whether to minify files when bundling.

Default: false

getNodeModules

@Stability(value=Experimental)
 @Nullable
default List<String> getNodeModules()

(experimental) 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.

Default: - all modules are bundled

getSourceMap

@Stability(value=Experimental)
 @Nullable
default Boolean getSourceMap()

(experimental) Whether to include source maps when bundling.

Default: false

getTarget

@Stability(value=Experimental)
 @Nullable
default String getTarget()

(experimental) Target environment for the generated JavaScript code.

Default: - the node version of the runtime

See Also:

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

getTsconfig

@Stability(value=Experimental)
 @Nullable
default String getTsconfig()

(experimental) 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.

Default: - automatically discovered by `esbuild`

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 {"tsconfig";"path/custom.tsconfig.json";
 }

builder

@Stability(value=Experimental)
static BundlingOptions.Builder builder()

Returns:

a BundlingOptions.Builder of BundlingOptions