software.amazon.awscdk.services.lambda.nodejs

Class BundlingOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.nodejs.BundlingOptions.Jsii$Proxy

All Implemented Interfaces:

BundlingOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

BundlingOptions

@Stability(value=Experimental)
 @Internal
public static final class BundlingOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements BundlingOptions

An implementation for BundlingOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.nodejs.BundlingOptions

BundlingOptions.Builder, BundlingOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(Map<String,String> buildArgs, ICommandHooks commandHooks, BundlingDockerImage dockerImage, Map<String,String> environment, String esbuildVersion, List<String> externalModules, Boolean forceDockerBundling, Boolean keepNames, Map<String,String> loader, LogLevel logLevel, Boolean minify, List<String> nodeModules, Boolean sourceMap, String target) Constructor that initializes the object based on literal property values passed by the BundlingOptions.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Map<String,String>	getBuildArgs() (experimental) Build arguments to pass when building the bundling image.
ICommandHooks	getCommandHooks() (experimental) Command hooks.
BundlingDockerImage	getDockerImage() (experimental) A custom bundling Docker image.
Map<String,String>	getEnvironment() (experimental) Environment variables defined when bundling runs.
String	getEsbuildVersion() (experimental) The version of esbuild to use when running in a Docker container.
List<String>	getExternalModules() (experimental) A list of modules that should be considered as externals (already available in the runtime).
Boolean	getForceDockerBundling() (experimental) Force bundling in a Docker container even if local bundling is possible.
Boolean	getKeepNames() (experimental) Whether to preserve the original `name` values even in minified code.
Map<String,String>	getLoader() (experimental) Use loaders to change how a given input file is interpreted.
LogLevel	getLogLevel() (experimental) Log level for esbuild.
Boolean	getMinify() (experimental) Whether to minify files when bundling.
List<String>	getNodeModules() (experimental) A list of modules that should be installed instead of bundled.
Boolean	getSourceMap() (experimental) Whether to include source maps when bundling.
String	getTarget() (experimental) Target environment for the generated JavaScript code.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.lambda.nodejs.BundlingOptions

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(Map<String,String> buildArgs,
                     ICommandHooks commandHooks,
                     BundlingDockerImage dockerImage,
                     Map<String,String> environment,
                     String esbuildVersion,
                     List<String> externalModules,
                     Boolean forceDockerBundling,
                     Boolean keepNames,
                     Map<String,String> loader,
                     LogLevel logLevel,
                     Boolean minify,
                     List<String> nodeModules,
                     Boolean sourceMap,
                     String target)

Constructor that initializes the object based on literal property values passed by the BundlingOptions.Builder.

Method Detail

getBuildArgs

public final Map<String,String> getBuildArgs()

Description copied from interface: BundlingOptions

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

Default: - no build arguments are passed

Specified by:

getBuildArgs in interface BundlingOptions

getCommandHooks

public final ICommandHooks getCommandHooks()

Description copied from interface: BundlingOptions

(experimental) Command hooks.

Default: - do not run additional commands

Specified by:

getCommandHooks in interface BundlingOptions

getDockerImage

public final BundlingDockerImage getDockerImage()

Description copied from interface: BundlingOptions

(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

Specified by:

getDockerImage in interface BundlingOptions

getEnvironment

public final Map<String,String> getEnvironment()

Description copied from interface: BundlingOptions

(experimental) Environment variables defined when bundling runs.

Default: - no environment variables are defined.

Specified by:

getEnvironment in interface BundlingOptions

getEsbuildVersion

public final String getEsbuildVersion()

Description copied from interface: BundlingOptions

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

Default: - latest v0

Specified by:

getEsbuildVersion in interface BundlingOptions

getExternalModules

public final List<String> getExternalModules()

Description copied from interface: BundlingOptions

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

Default: ['aws-sdk']

Specified by:

getExternalModules in interface BundlingOptions

getForceDockerBundling

public final Boolean getForceDockerBundling()

Description copied from interface: BundlingOptions

(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

Specified by:

getForceDockerBundling in interface BundlingOptions

getKeepNames

public final Boolean getKeepNames()

Description copied from interface: BundlingOptions

(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

Specified by:

getKeepNames in interface BundlingOptions

getLoader

public final Map<String,String> getLoader()

Description copied from interface: BundlingOptions

(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";
 }

Specified by:

getLoader in interface BundlingOptions

See Also:

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

getLogLevel

public final LogLevel getLogLevel()

Description copied from interface: BundlingOptions

(experimental) Log level for esbuild.

Default: LogLevel.WARNING

Specified by:

getLogLevel in interface BundlingOptions

getMinify

public final Boolean getMinify()

Description copied from interface: BundlingOptions

(experimental) Whether to minify files when bundling.

Default: false

Specified by:

getMinify in interface BundlingOptions

getNodeModules

public final List<String> getNodeModules()

Description copied from interface: BundlingOptions

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

Default: - all modules are bundled

Specified by:

getNodeModules in interface BundlingOptions

getSourceMap

public final Boolean getSourceMap()

Description copied from interface: BundlingOptions

(experimental) Whether to include source maps when bundling.

Default: false

Specified by:

getSourceMap in interface BundlingOptions

getTarget

public final String getTarget()

Description copied from interface: BundlingOptions

(experimental) Target environment for the generated JavaScript code.

Default: - the node version of the runtime

Specified by:

getTarget in interface BundlingOptions

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object