Interface NodeJsLambdaOptions

The file path to the entry file for your Lambda function's handler, relative to the root of your project.

This is the TypeScript or JavaScript file that exports the handler function.

Example

const entry = './src/index.ts';
Copy

The name of the handler function exported from your entry file.

This should match the name of the function exported in your entry file that will be invoked by AWS Lambda.

Example

// In your entry file, you might have:
export const handle = async (event) => { ... };

// Then, specify:
const handler = 'handle';
Copy

The Node.js runtime environment to use for the Lambda function.

Defaults to NODEJS_20_X.

Example

import * as lambda from 'aws-cdk-lib/aws-lambda';

const runtime = lambda.Runtime.NODEJS_20_X;
Copy

The amount of memory, in MB, allocated to your Lambda function.

Any number divisible by 64 between 128 and 10240 (10GB),

Defaults to 128.

The maximum time (in seconds) that the Lambda function can run before it is terminated by AWS.

Defaults to 30 seconds.

Example

import { Duration } from 'aws-cdk-lib';

const timeout = Duration.seconds(20);
Copy

Key-value pairs that are set as environment variables for the Lambda function.

These can be accessed in your handler code using process.env.

Example

const environment = {
  STAGE: 'production',
  API_KEY: 'my-secret-key',
};
Copy

The maximum number of concurrent executions for the Lambda function.

This limits the number of instances of the function that can be running at the same time.

Example

const concurrentExecutions = 10;
Copy

Inline Lambda code. (Mostly used just for testing...)

Additional bundling options to customize the esbuild bundling process.

These options will be merged with the default bundling configuration.

Example

const bundlingOptions = {
  minify: true,
  target: 'es2020',
  define: {
    'process.env.NODE_ENV': '"production"'
  },
  external: ['aws-sdk']
};
Copy

Any other available props to configure your Lambda.