software.amazon.awscdk.services.lambda.nodejs

Class ParcelOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ParcelOptions>

Enclosing interface:

ParcelOptions

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

A builder for ParcelOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ParcelOptions	build() Builds the configured instance.
ParcelOptions.Builder	buildArgs(Map<String,String> buildArgs) Sets the value of ParcelBaseOptions.getBuildArgs()
ParcelOptions.Builder	bundlingDockerImage(BundlingDockerImage bundlingDockerImage) Sets the value of ParcelBaseOptions.getBundlingDockerImage()
ParcelOptions.Builder	cacheDir(String cacheDir) Sets the value of ParcelBaseOptions.getCacheDir()
ParcelOptions.Builder	entry(String entry) Sets the value of ParcelOptions.getEntry()
ParcelOptions.Builder	externalModules(List<String> externalModules) Sets the value of ParcelBaseOptions.getExternalModules()
ParcelOptions.Builder	forceDockerBundling(Boolean forceDockerBundling) Sets the value of ParcelBaseOptions.getForceDockerBundling()
ParcelOptions.Builder	minify(Boolean minify) Sets the value of ParcelBaseOptions.getMinify()
ParcelOptions.Builder	nodeModules(List<String> nodeModules) Sets the value of ParcelBaseOptions.getNodeModules()
ParcelOptions.Builder	parcelEnvironment(Map<String,String> parcelEnvironment) Sets the value of ParcelBaseOptions.getParcelEnvironment()
ParcelOptions.Builder	parcelVersion(String parcelVersion) Sets the value of ParcelBaseOptions.getParcelVersion()
ParcelOptions.Builder	projectRoot(String projectRoot) Sets the value of ParcelBaseOptions.getProjectRoot()
ParcelOptions.Builder	runtime(Runtime runtime) Sets the value of ParcelOptions.getRuntime()
ParcelOptions.Builder	sourceMaps(Boolean sourceMaps) Sets the value of ParcelBaseOptions.getSourceMaps()

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

entry

@Stability(value=Experimental)
public ParcelOptions.Builder entry(String entry)

Sets the value of ParcelOptions.getEntry()

Parameters:

entry - Entry file. This parameter is required.

Returns:

this

runtime

@Stability(value=Experimental)
public ParcelOptions.Builder runtime(Runtime runtime)

Sets the value of ParcelOptions.getRuntime()

Parameters:

runtime - The runtime of the lambda function. This parameter is required.

Returns:

this

buildArgs

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

Sets the value of ParcelBaseOptions.getBuildArgs()

Parameters:

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

Returns:

this

bundlingDockerImage

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

Sets the value of ParcelBaseOptions.getBundlingDockerImage()

Parameters:

bundlingDockerImage - A custom bundling Docker image. This image should have Parcel installed at /. 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/parcel/Dockerfile for the default image provided by @aws-cdk/aws-lambda-nodejs.

Returns:

this

cacheDir

@Stability(value=Experimental)
public ParcelOptions.Builder cacheDir(String cacheDir)

Sets the value of ParcelBaseOptions.getCacheDir()

Parameters:

cacheDir - The cache directory (relative to the project root). Parcel uses a filesystem cache for fast rebuilds.

Returns:

this

externalModules

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

Sets the value of ParcelBaseOptions.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 ParcelOptions.Builder forceDockerBundling(Boolean forceDockerBundling)

Sets the value of ParcelBaseOptions.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

minify

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

Sets the value of ParcelBaseOptions.getMinify()

Parameters:

minify - Whether to minify files when bundling.

Returns:

this

nodeModules

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

Sets the value of ParcelBaseOptions.getNodeModules()

Parameters:

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

Returns:

this

parcelEnvironment

@Stability(value=Experimental)
public ParcelOptions.Builder parcelEnvironment(Map<String,String> parcelEnvironment)

Sets the value of ParcelBaseOptions.getParcelEnvironment()

Parameters:

parcelEnvironment - Environment variables defined when Parcel runs.

Returns:

this

parcelVersion

@Stability(value=Experimental)
public ParcelOptions.Builder parcelVersion(String parcelVersion)

Sets the value of ParcelBaseOptions.getParcelVersion()

Parameters:

parcelVersion - The version of Parcel to use when running in a Docker container.

Returns:

this

projectRoot

@Stability(value=Experimental)
public ParcelOptions.Builder projectRoot(String projectRoot)

Sets the value of ParcelBaseOptions.getProjectRoot()

Parameters:

projectRoot - The root of the project. This will be used as the source for the volume mounted in the Docker container. If you specify this prop, ensure that this path includes entry and any module/dependencies used by your function otherwise bundling will not be possible.

Returns:

this

sourceMaps

@Stability(value=Experimental)
public ParcelOptions.Builder sourceMaps(Boolean sourceMaps)

Sets the value of ParcelBaseOptions.getSourceMaps()

Parameters:

sourceMaps - Whether to include source maps when bundling.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ParcelOptions

Throws:

NullPointerException - if any required attribute was not provided