FunctionConfigurationProperty Struct
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 Developer Guide .
In an CloudFormation template, FunctionConfiguration is a property of the Function property type.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_greengrass as greengrass } from 'aws-cdk-lib';
declare const variables: any;
const functionConfigurationProperty: greengrass.CfnFunctionDefinition.FunctionConfigurationProperty = {
encodingType: 'encodingType',
environment: {
accessSysfs: false,
execution: {
isolationMode: 'isolationMode',
runAs: {
gid: 123,
uid: 123,
},
},
resourceAccessPolicies: [{
resourceId: 'resourceId',
// the properties below are optional
permission: 'permission',
}],
variables: variables,
},
execArgs: 'execArgs',
executable: 'executable',
memorySize: 123,
pinned: false,
timeout: 123,
};
Properties
encodingTypeoptionalstringencoding_typeoptionalstrencodingTypeoptionalStringEncodingTypeoptionalstringEncodingTypeoptional*string#The expected encoding type of the input payload for the function.
Valid values are json (default) and binary .
environmentoptionalIResolvable | CfnFunctionDefinition.EnvironmentPropertyenvironmentoptionaltyping.Union[IResolvable, EnvironmentProperty]environmentoptionalIResolvableEnvironmentoptionalIResolvableEnvironmentoptionalinterface{}#The environment configuration of the function.
execArgsoptionalstringexec_argsoptionalstrexecArgsoptionalStringExecArgsoptionalstringExecArgsoptional*string#The execution arguments.
executableoptionalstringexecutableoptionalstrexecutableoptionalStringExecutableoptionalstringExecutableoptional*string#The name of the function executable.
memorySizeoptionalnumbermemory_sizeoptionalint | floatmemorySizeoptionalNumberMemorySizeoptionaldoubleMemorySizeoptional*float64#The memory size (in KB) required by the function.
This property applies only to Lambda functions that run in a Greengrass container.
pinnedoptionalboolean | IResolvablepinnedoptionaltyping.Union[bool, IResolvable]pinnedoptionalBooleanPinnedoptionalboolPinnedoptionalinterface{}#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.
timeoutoptionalnumbertimeoutoptionalint | floattimeoutoptionalNumberTimeoutoptionaldoubleTimeoutoptional*float64#The allowed execution time (in seconds) after which the function should terminate.
For pinned functions, this timeout applies for each request.