Run/Debug Configurations dialog box (local function settings) - AWS Toolkit for JetBrains

Run/Debug Configurations dialog box (local function settings)

This dialog box is displayed whenever you update settings for the local version of an AWS Lambda function.

Note

To update settings for the remote version of that same function (the function's source code is in Lambda in your AWS account), see Run/Debug Configurations dialog box (remote function settings) instead.

This dialog box contains three tabs: Configuration, SAM CLI, and AWS Connection.

The Configuration tab of the Run/Debug Configurations dialog box for local function settings.

The Configuration tab of the Run/Debug Configurations dialog box for local function settings contains the following items:

Name

(Required) The name of this configuration.

Allow parallel run / Allow running in parallel

(Optional) If selected, allows IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider to launch as many instances of the configuration to run in parallel as needed.1

From handler / From template

(Required) Depending on which option you choose, you must configure additional settings.

Runtime

(Required) The ID of the Lambda runtime to use.

Handler

(Required for the From handler option) The identifier of the corresponding function handler for Java, Python, Node.js, or C#.

Timeout (seconds)

(Required for the From handler option) The amount of time that Lambda allows a function to run before stopping it. Specify an amount up to 900 seconds (15 minutes).

Memory (MB)

(Required for the From handler option) The amount of memory available to the function as it runs. Specify an amount between 128 MB and 3,008 MB in 64-MB increments.

Environment Variables

(Optional for the From handler option) Any environment variables for the Lambda function to use, specified as key-value pairs. To add, change, or delete environment variables, choose the folder icon, and then follow the on-screen instructions.

Template

(Required for the From template option) The location and file name of the AWS Serverless Application Model (AWS SAM) template (for example, template.yaml) to use for this configuration, and the resource in that template to associate with this configuration.

File

(Required) The location and file name of the event data to pass to the function, in JSON format. For event data examples, see Invoke the Lambda function in the AWS Lambda Developer Guide and Generating sample event payloads in the AWS Serverless Application Model Developer Guide.

Text

(Required) The event data to pass to the function, in JSON format. For event data examples, see Invoke the Lambda function in the AWS Lambda Developer Guide and Generating sample event payloads in the AWS Serverless Application Model Developer Guide.

Note

Either File or Text is required, but not both.

Before launch: window

(Optional) Lists any tasks that must be performed before starting this configuration.2

Notes

1 For more information, see the following:

2 For more information, see the following:

The SAM CLI tab of the Run/Debug Configurations dialog box for local function settings.

The SAM CLI tab of the Run/Debug Configurations dialog box for local function settings contains the following items:

Name

(Required) The name of this configuration.

Allow parallel run / Allow running in parallel

(Optional) If selected, allows IntelliJ IDEA, PyCharm, WebStorm, or JetBrains Rider to launch as many instances of the configuration to run in parallel as needed.1

Build function inside a container

(Optional) If selected, the AWS SAM CLI builds any of the serverless application's functions inside of a Lambda-like Docker container locally before deployment. This is useful if the function depends on packages that have natively compiled dependencies or programs. For more information, see Building applications in the AWS Serverless Application Model Developer Guide.

Skip checking for newer container images

(Optional) If selected, the AWS SAM CLI skips pulling down the latest Docker image for the runtime that is specified on the Configuration tab.

Docker Network

(Optional) The name or ID of an existing Docker network for Lambda Docker containers to connect to, with the default bridge network. If not specified, the Lambda containers connect only to the default bridge Docker network.

Before launch: window

(Optional) Lists any tasks that must be performed before starting this configuration.2

Notes

1 For more information, see the following:

2 For more information, see the following:

The AWS Connection tab of the Run/Debug Configurations dialog box for local function settings.

The AWS Connection tab of the Run/Debug Configurations dialog box for local function settings contains the following items:

Credentials

(Required) The name of the existing AWS account connection to use.

Region

(Required) The name of the AWS Region to use for the connected account.

Notes

1 For more information, see the following:

2 For more information, see the following: