AWS CloudFormation
User Guide (Version )

AWS::Greengrass::FunctionDefinition FunctionConfiguration

The group-specific configuration settings for a Lambda function. These settings configure the function's behavior in the Greengrass group. For more information, see Controlling Execution of Greengrass Lambda Functions by Using Group-Specific Configuration in the AWS IoT Greengrass Developer Guide.

In an AWS CloudFormation template, FunctionConfiguration is a property of the Function property type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "EncodingType" : String, "Environment" : Environment, "ExecArgs" : String, "Executable" : String, "MemorySize" : Integer, "Pinned" : Boolean, "Timeout" : Integer }

YAML

EncodingType: String Environment: Environment ExecArgs: String Executable: String MemorySize: Integer Pinned: Boolean Timeout: Integer

Properties

EncodingType

The expected encoding type of the input payload for the function. Valid values are json (default) and binary.

Required: No

Type: String

Update requires: Replacement

Environment

The environment configuration of the function.

Required: No

Type: Environment

Update requires: Replacement

ExecArgs

The execution arguments.

Required: No

Type: String

Update requires: Replacement

Executable

The name of the function executable.

Required: No

Type: String

Update requires: Replacement

MemorySize

The memory size (in KB) required by the function.

Note

This property applies only to Lambda functions that run in a Greengrass container.

Required: No

Type: Integer

Update requires: Replacement

Pinned

Indicates whether the function is pinned (or long-lived). Pinned functions start when the core starts and process all requests in the same container. The default value is false.

Required: No

Type: Boolean

Update requires: No interruption

Timeout

The allowed execution time (in seconds) after which the function should terminate. For pinned functions, this timeout applies for each request.

Required: No

Type: Integer

Update requires: Replacement

See Also

On this page: