software.amazon.awscdk.services.lambda.nodejs

Interface ParcelBaseOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

NodejsFunctionProps, ParcelOptions

All Known Implementing Classes:

NodejsFunctionProps.Jsii$Proxy, ParcelBaseOptions.Jsii$Proxy, ParcelOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.13.0 (build 385c325)",
           date="2020-10-07T19:57:40.498Z")
 @Stability(value=Experimental)
public interface ParcelBaseOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Base options for Parcel bundling.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ParcelBaseOptions.Builder	builder()
default Map<String,String>	getBuildArgs() (experimental) Build arguments to pass when building the bundling image.
default BundlingDockerImage	getBundlingDockerImage() (experimental) A custom bundling Docker image.
default String	getCacheDir() (experimental) The cache directory (relative to the project root).
default List<String>	getExternalModules() (experimental) A list of modules that should be considered as externals (already available in the runtime).
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 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 Map<String,String>	getParcelEnvironment() (experimental) Environment variables defined when Parcel runs.
default String	getParcelVersion() (experimental) The version of Parcel to use when running in a Docker container.
default String	getProjectRoot() (experimental) The root of the project.
default Boolean	getSourceMaps() (experimental) Whether to include source maps when bundling.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

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

getBundlingDockerImage

@Stability(value=Experimental)
 @Nullable
default BundlingDockerImage getBundlingDockerImage()

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

Default: - use the Docker image provided by

getCacheDir

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

(experimental) The cache directory (relative to the project root).

Parcel uses a filesystem cache for fast rebuilds.

Default: - `.parcel-cache` in the working directory

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']

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

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

Default: - all modules are bundled

getParcelEnvironment

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

(experimental) Environment variables defined when Parcel runs.

Default: - no environment variables are defined.

getParcelVersion

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

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

Default: - 2.0.0-beta.1

getProjectRoot

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

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

Default: - the closest path containing a .git folder

getSourceMaps

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

(experimental) Whether to include source maps when bundling.

Default: false

builder

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

Returns:

a ParcelBaseOptions.Builder of ParcelBaseOptions