software.amazon.awscdk.services.lambda.nodejs

Interface NodejsFunctionProps

All Superinterfaces:

EventInvokeConfigOptions, FunctionOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NodejsFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.6.0 (build 248e75b)",
           date="2020-06-04T00:02:21.528Z")
 @Stability(value=Experimental)
public interface NodejsFunctionProps
extends software.amazon.jsii.JsiiSerializable, FunctionOptions

Properties for a NodejsFunction.

EXPERIMENTAL

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static NodejsFunctionProps.Builder	builder()
default String	getBuildDir() The build directory.
default String	getCacheDir() The cache directory.
default Map<String,String>	getContainerEnvironment() The environment variables to pass to the container running Parcel.
default String	getEntry() Path to the entry file (JavaScript or TypeScript).
default String	getHandler() The name of the exported handler in the entry file.
default Boolean	getMinify() Whether to minify files when bundling.
default String	getNodeDockerTag() The docker tag of the node base image to use in the parcel-bundler docker image.
default String	getProjectRoot() The root of the project.
default Runtime	getRuntime() The runtime environment.
default Boolean	getSourceMaps() Whether to include source maps when bundling.

Methods inherited from interface software.amazon.awscdk.services.lambda.FunctionOptions

getAllowAllOutbound, getCurrentVersionOptions, getDeadLetterQueue, getDeadLetterQueueEnabled, getDescription, getEnvironment, getEvents, getFunctionName, getInitialPolicy, getLayers, getLogRetention, getLogRetentionRole, getMemorySize, getReservedConcurrentExecutions, getRole, getSecurityGroup, getSecurityGroups, getTimeout, getTracing, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuildDir

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

The build directory.

Default: - `.build` in the entry file directory

EXPERIMENTAL

getCacheDir

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

The cache directory.

Parcel uses a filesystem cache for fast rebuilds.

Default: - `.cache` in the root directory

EXPERIMENTAL

getContainerEnvironment

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

The environment variables to pass to the container running Parcel.

Default: - no environment variables are passed to the container

EXPERIMENTAL

getEntry

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

Path to the entry file (JavaScript or TypeScript).

Default: - Derived from the name of the defining file and the construct's id. If the `NodejsFunction` is defined in `stack.ts` with `my-handler` as id (`new NodejsFunction(this, 'my-handler')`), the construct will look at `stack.my-handler.ts` and `stack.my-handler.js`.

EXPERIMENTAL

getHandler

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

The name of the exported handler in the entry file.

Default: handler

EXPERIMENTAL

getMinify

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

Whether to minify files when bundling.

Default: false

EXPERIMENTAL

getNodeDockerTag

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

The docker tag of the node base image to use in the parcel-bundler docker image.

Default: - the `process.versions.node` alpine image

EXPERIMENTAL

See Also:

https://hub.docker.com/_/node/?tab=tags

getProjectRoot

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

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

EXPERIMENTAL

getRuntime

@Stability(value=Experimental)
 @Nullable
default Runtime getRuntime()

The runtime environment.

Only runtimes of the Node.js family are supported.

Default: - `NODEJS_12_X` if `process.versions.node` >= '12.0.0', `NODEJS_10_X` otherwise.

EXPERIMENTAL

getSourceMaps

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

Whether to include source maps when bundling.

Default: false

EXPERIMENTAL

builder

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

Specified by:

builder in interface EventInvokeConfigOptions

Specified by:

builder in interface FunctionOptions

Returns:

a NodejsFunctionProps.Builder of NodejsFunctionProps