software.amazon.awscdk.services.lambda.nodejs

Interface NodejsFunctionProps

All Superinterfaces:

software.amazon.awscdk.services.lambda.EventInvokeConfigOptions, software.amazon.awscdk.services.lambda.FunctionOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NodejsFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.21.2 (build 4370756)",
           date="2020-02-07T03:00:57.031Z")
 @Stability(value=Experimental)
public interface NodejsFunctionProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.lambda.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 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 software.amazon.awscdk.services.lambda.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, 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)
default String getBuildDir()

The build directory.

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

EXPERIMENTAL

getCacheDir

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

The cache directory.

Parcel uses a filesystem cache for fast rebuilds.

Default: - `.cache` in the root directory

EXPERIMENTAL

getEntry

@Stability(value=Experimental)
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)
default String getHandler()

The name of the exported handler in the entry file.

Default: handler

EXPERIMENTAL

getMinify

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

Whether to minify files when bundling.

Default: false

EXPERIMENTAL

getRuntime

@Stability(value=Experimental)
default software.amazon.awscdk.services.lambda.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)
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 software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

Specified by:

builder in interface software.amazon.awscdk.services.lambda.FunctionOptions

Returns:

a NodejsFunctionProps.Builder of NodejsFunctionProps