interface FunctionProperty

Language	Type name
.NET	Amazon.CDK.AWS.Greengrass.CfnFunctionDefinition.FunctionProperty
Java	software.amazon.awscdk.services.greengrass.CfnFunctionDefinition.FunctionProperty
Python	aws_cdk.aws_greengrass.CfnFunctionDefinition.FunctionProperty
TypeScript	@aws-cdk/aws-greengrass » CfnFunctionDefinition » FunctionProperty

A function is a Lambda function that's referenced from an AWS IoT Greengrass group.

The function is deployed to a Greengrass core where it runs locally. For more information, see Run Lambda Functions on the AWS IoT Greengrass Core in the Developer Guide .

In an AWS CloudFormation template, the Functions property of the FunctionDefinitionVersion property type contains a list of Function property types.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as greengrass from '@aws-cdk/aws-greengrass';

declare const variables: any;
const functionProperty: greengrass.CfnFunctionDefinition.FunctionProperty = {
  functionArn: 'functionArn',
  functionConfiguration: {
    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,
  },
  id: 'id',
};

Properties

Name	Type	Description
functionArn	string	The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.
functionConfiguration	IResolvable | FunctionConfigurationProperty	The group-specific settings of the Lambda function.
id	string	A descriptive or arbitrary ID for the function.

---

functionArn

Type: string

The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.

---

functionConfiguration

Type: IResolvable | FunctionConfigurationProperty

The group-specific settings of the Lambda function.

These settings configure the function's behavior in the Greengrass group.

---

id

Type: string

A descriptive or arbitrary ID for the function.

This value must be unique within the function definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .