software.amazon.awscdk.services.lambda.nodejs

Class BundlingOptions.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.nodejs.BundlingOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BundlingOptions>

Enclosing interface:

BundlingOptions

@Stability(value=Experimental)
public static final class BundlingOptions.Builder
extends Object
implements software.amazon.jsii.Builder<BundlingOptions>

A builder for BundlingOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BundlingOptions	build() Builds the configured instance.
BundlingOptions.Builder	buildArgs(Map<String,String> buildArgs) Sets the value of BundlingOptions.getBuildArgs()
BundlingOptions.Builder	bundlingDockerImage(BundlingDockerImage bundlingDockerImage) Sets the value of BundlingOptions.getBundlingDockerImage()
BundlingOptions.Builder	bundlingEnvironment(Map<String,String> bundlingEnvironment) Sets the value of BundlingOptions.getBundlingEnvironment()
BundlingOptions.Builder	esbuildVersion(String esbuildVersion) Sets the value of BundlingOptions.getEsbuildVersion()
BundlingOptions.Builder	externalModules(List<String> externalModules) Sets the value of BundlingOptions.getExternalModules()
BundlingOptions.Builder	forceDockerBundling(Boolean forceDockerBundling) Sets the value of BundlingOptions.getForceDockerBundling()
BundlingOptions.Builder	loader(Map<String,String> loader) Sets the value of BundlingOptions.getLoader()
BundlingOptions.Builder	minify(Boolean minify) Sets the value of BundlingOptions.getMinify()
BundlingOptions.Builder	nodeModules(List<String> nodeModules) Sets the value of BundlingOptions.getNodeModules()
BundlingOptions.Builder	sourceMap(Boolean sourceMap) Sets the value of BundlingOptions.getSourceMap()
BundlingOptions.Builder	target(String target) Sets the value of BundlingOptions.getTarget()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

buildArgs

@Stability(value=Experimental)
public BundlingOptions.Builder buildArgs(Map<String,String> buildArgs)

Sets the value of BundlingOptions.getBuildArgs()

Parameters:

buildArgs - Build arguments to pass when building the bundling image.

Returns:

this

bundlingDockerImage

@Stability(value=Experimental)
public BundlingOptions.Builder bundlingDockerImage(BundlingDockerImage bundlingDockerImage)

Sets the value of BundlingOptions.getBundlingDockerImage()

Parameters:

bundlingDockerImage - 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.

Returns:

this

bundlingEnvironment

@Stability(value=Experimental)
public BundlingOptions.Builder bundlingEnvironment(Map<String,String> bundlingEnvironment)

Sets the value of BundlingOptions.getBundlingEnvironment()

Parameters:

bundlingEnvironment - Environment variables defined when bundling runs.

Returns:

this

esbuildVersion

@Stability(value=Experimental)
public BundlingOptions.Builder esbuildVersion(String esbuildVersion)

Sets the value of BundlingOptions.getEsbuildVersion()

Parameters:

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

Returns:

this

externalModules

@Stability(value=Experimental)
public BundlingOptions.Builder externalModules(List<String> externalModules)

Sets the value of BundlingOptions.getExternalModules()

Parameters:

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

Returns:

this

forceDockerBundling

@Stability(value=Experimental)
public BundlingOptions.Builder forceDockerBundling(Boolean forceDockerBundling)

Sets the value of BundlingOptions.getForceDockerBundling()

Parameters:

forceDockerBundling - 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.

Returns:

this

loader

@Stability(value=Experimental)
public BundlingOptions.Builder loader(Map<String,String> loader)

Sets the value of BundlingOptions.getLoader()

Parameters:

loader - 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.

Returns:

this

minify

@Stability(value=Experimental)
public BundlingOptions.Builder minify(Boolean minify)

Sets the value of BundlingOptions.getMinify()

Parameters:

minify - Whether to minify files when bundling.

Returns:

this

nodeModules

@Stability(value=Experimental)
public BundlingOptions.Builder nodeModules(List<String> nodeModules)

Sets the value of BundlingOptions.getNodeModules()

Parameters:

nodeModules - A list of modules that should be installed instead of bundled. Modules are installed in a Lambda compatible environnment only when bundling runs in Docker.

Returns:

this

sourceMap

@Stability(value=Experimental)
public BundlingOptions.Builder sourceMap(Boolean sourceMap)

Sets the value of BundlingOptions.getSourceMap()

Parameters:

sourceMap - Whether to include source maps when bundling.

Returns:

this

target

@Stability(value=Experimental)
public BundlingOptions.Builder target(String target)

Sets the value of BundlingOptions.getTarget()

Parameters:

target - Target environment for the generated JavaScript code.

Returns:

this

build

@Stability(value=Experimental)
public BundlingOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BundlingOptions>

Returns:

a new instance of BundlingOptions

Throws:

NullPointerException - if any required attribute was not provided