software.amazon.awscdk.services.lambda.nodejs

Interface NodejsFunctionProps

All Superinterfaces:

EventInvokeConfigOptions, FunctionOptions, software.amazon.jsii.JsiiSerializable, ParcelBaseOptions

All Known Implementing Classes:

NodejsFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.7.0 (build 179a3a5)",
           date="2020-07-01T08:46:39.126Z")
 @Stability(value=Experimental)
public interface NodejsFunctionProps
extends software.amazon.jsii.JsiiSerializable, FunctionOptions, ParcelBaseOptions

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	getEntry() Path to the entry file (JavaScript or TypeScript).
default String	getHandler() The name of the exported handler in the entry file.
default Runtime	getRuntime() The runtime environment.

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

getAllowAllOutbound, getCurrentVersionOptions, getDeadLetterQueue, getDeadLetterQueueEnabled, getDescription, getEnvironment, getEvents, getFunctionName, getInitialPolicy, getLayers, getLogRetention, getLogRetentionRetryOptions, 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

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

getCacheDir, getExternalModules, getMinify, getNodeModules, getParcelEnvironment, getParcelVersion, getProjectRoot, getSourceMaps

Method Detail

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

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

builder

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

Specified by:

builder in interface EventInvokeConfigOptions

Specified by:

builder in interface FunctionOptions

Specified by:

builder in interface ParcelBaseOptions

Returns:

a NodejsFunctionProps.Builder of NodejsFunctionProps