LambdaExecutionParameters
Contains parameters for a Lambda function that runs on AWS IoT Greengrass.
Contents
- environmentVariables
-
The map of environment variables that are available to the Lambda function when it runs.
Type: String to string map
Key Length Constraints: Minimum length of 1.
Required: No
- eventSources
-
The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and AWS IoT Core MQTT messages.
Type: Array of LambdaEventSource objects
Required: No
- execArgs
-
The list of arguments to pass to the Lambda function when it runs.
Type: Array of strings
Required: No
- inputPayloadEncodingType
-
The encoding type that the Lambda function supports.
Default:
jsonType: String
Valid Values:
json | binaryRequired: No
- linuxProcessParams
-
The parameters for the Linux process that contains the Lambda function.
Type: LambdaLinuxProcessParams object
Required: No
- maxIdleTimeInSeconds
-
The maximum amount of time in seconds that a non-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process.
Type: Integer
Required: No
- maxInstancesCount
-
The maximum number of instances that a non-pinned Lambda function can run at the same time.
Type: Integer
Required: No
- maxQueueSize
-
The maximum size of the message queue for the Lambda function component. The AWS IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message.
Type: Integer
Required: No
- pinned
-
Whether or not the Lambda function is pinned, or long-lived.
-
A pinned Lambda function starts when AWS IoT Greengrass starts and keeps running in its own container.
-
A non-pinned Lambda function starts only when it receives a work item and exists after it idles for
maxIdleTimeInSeconds. If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function.
Default:
trueType: Boolean
Required: No
-
- statusTimeoutInSeconds
-
The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component.
Type: Integer
Required: No
- timeoutInSeconds
-
The maximum amount of time in seconds that the Lambda function can process a work item.
Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
