Type Alias FunctionProps

The architecture of the target platform for the lambda environment. Defaults to X86_64.

The path to the file that contains the function entry point. If this is a relative path, it is computed relative to the file where this function is defined

Defaults to './handler.ts'

Environment variables that will be available during function execution

The size of the function's /tmp directory in MB. Must be a whole number.

Attach Lambda layers to a function

• A Lambda layer is represented by an object of key/value pair where the key is the module name that is exported from your layer and the value is the ARN of the layer. The key (module name) is used to externalize the module dependency so it doesn't get bundled with your lambda function
• Maximum of 5 layers can be attached to a function and must be in the same region as the function.

An amount of memory (RAM) to allocate to the function between 128 and 10240 MB. Must be a whole number. Default is 512MB.

A name for the function. Defaults to the basename of the entry path if specified. If no entry is specified, defaults to the directory name in which this function is defined.

Example: If entry is ./scheduled-db-backup.ts the name will default to "scheduled-db-backup" If entry is not set and the function is defined in amplify/functions/db-backup/resource.ts the name will default to "db-backup"

Group the function with existing Amplify resources or separate the function into its own group.

Node runtime version for the lambda environment.

Defaults to the oldest NodeJS LTS version. See https://nodejs.org/en/about/previous-releases

A time interval string to periodically run the function. This can be either a string of "every <positive whole number><m (minute) or h (hour)>", "every day|week|month|year" or cron expression. Defaults to no scheduling for the function.

An amount of time in seconds between 1 second and 15 minutes. Must be a whole number. Default is 3 seconds.