interface FunctionConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgreengrass#CfnFunctionDefinitionVersion_FunctionConfigurationProperty`
Java	`software.amazon.awscdk.services.greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty`
Python	`aws_cdk.aws_greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_greengrass` » `CfnFunctionDefinitionVersion` » `FunctionConfigurationProperty`

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 AWS CloudFormation template, FunctionConfiguration is a property of the Function property type.

Example

// 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.CfnFunctionDefinitionVersion.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

Name	Type	Description
encodingType?	`string`	The expected encoding type of the input payload for the function.
environment?	`IResolvable` `\|` `EnvironmentProperty`	The environment configuration of the function.
execArgs?	`string`	The execution arguments.
executable?	`string`	The name of the function executable.
memorySize?	`number`	The memory size (in KB) required by the function.
pinned?	`boolean \|` `IResolvable`	Indicates whether the function is pinned (or long-lived ).
timeout?	`number`	The allowed execution time (in seconds) after which the function should terminate.

encodingType?

Type: string (optional)

The expected encoding type of the input payload for the function.

Valid values are json (default) and binary .

environment?

Type: IResolvable | EnvironmentProperty (optional)

The environment configuration of the function.

execArgs?

Type: string (optional)

The execution arguments.

executable?

Type: string (optional)

The name of the function executable.

memorySize?

Type: number (optional)

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

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

pinned?

Type: boolean | IResolvable (optional)

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.

timeout?

Type: number (optional)

The allowed execution time (in seconds) after which the function should terminate.

For pinned functions, this timeout applies for each request.