将 Lambda 函数作为组件导入 (Amazon CLI) - Amazon IoT Greengrass
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

将 Lambda 函数作为组件导入 (Amazon CLI)

使用创建组件版本从 Lambda 函数创建组件。调用此操作时,指定lambdaFunction导入 Lambda 函数。

第 1 步:定义 Lambda 函数配置

  1. 创建一个名为的文件lambda-function-component.json,然后将以下 JSON 对象复制到该文件中。替换lambdaArn将导入 Lambda 函数的 ARN。

    { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1" } }
    重要

    您必须指定一个包含要导入的函数版本的 ARN。您不能使用像 $LATEST 这样的版本别名。

  2. (可选)指定名称 (componentName) 组件的。如果省略此参数,Amazon IoT Greengrass以 Lambda 函数名称创建组件。

    { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda" } }
  3. (可选)指定版本 (componentVersion) 对于组件。如果省略此参数,Amazon IoT Greengrass以 Lambda 函数版本作为有效语义版本创建组件。例如,如果您的函数版本是 3,则组件版本将变为 3.0.0

    注意

    您上传的每个组件版本必须是唯一的。请确保上传了正确的组件版本,因为上传后无法对其进行编辑。

    Amazon IoT Greengrass对组件使用语义版本。语义版本遵循重大的.未成年人.补丁号码系统。例如,版本1.0.0代表组件的第一个主要版本。有关更多信息,请参阅 。语义版本规格.

    { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0" } }
  4. (可选)指定此 Lambda 函数支持的平台。每个平台都包含标识平台的属性映射。所有核心设备都具有操作系统的属性(os) 和体系结构 (architecture)。这些区域有:Amazon IoT Greengrass核心软件可能会添加其他平台属性。还可以在部署时指定自定义平台属性Greengrass 核心组件将转换到核心设备。执行以下操作:

    1. 添加平台列表 (componentPlatforms) 到中的 Lambda 函数lambda-function-component.json.

      { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ ] } }
    2. 将每个受支持的平台添加到列表中。每个平台都有友好的平台name以识别它和属性映射。以下示例指定此函数支持运行 Linux 的 x86 设备。

      { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } }

      您的lambda-function-component.json可能包含类似于以下示例的文档。

      { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ] } }
  5. (可选)指定 Lambda 函数的组件依赖关系。当您部署 Lambda 函数组件时,部署包括这些依赖项,供您的函数运行。

    重要

    导入创建要在其上运行的 Lambda 函数Amazon IoT GreengrassV1,您必须为函数使用的功能(例如密码、本地阴影和流管理器)定义单个组件依赖关系。将这些组件定义为硬依赖关系以便在依赖项更改状态时,Lambda 函数组件可以重新启动。有关更多信息,请参阅 导入 V1 Lambda 函数

    执行以下操作:

    1. 添加组件依赖关系的映射 (componentDependencies) 到中的 Lambda 函数lambda-function-component.json.

      { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { } } }
    2. 将每个组件依赖项添加到地图中。将组件名称指定为密钥,并指定一个具有以下参数的对象:

      • versionRequirement— npm风格的语义版本约束,用于标识组件依赖关系的兼容版本。可以指定单个版本或一系列版本。有关语义版本约束的更多信息,请参阅npm semver 计算器.

      • dependencyType—(可选)依赖项的类型。从以下选项中进行选择:

        • SOFT— 如果依赖项更改状态,Lambda 函数组件不会重新启动。

        • HARD— 如果依赖项更改状态,Lambda 函数组件将会重新启动。

        默认为 HARD

      以下示例指定此 Lambda 函数取决于第一个主要版本中的任何版本流管理器组件. 当流管理器重新启动或更新时,Lambda 函数组件将重新启动。

      { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }

      您的lambda-function-component.json可能包含类似于以下示例的文档。

      { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } } } }
  6. (可选)配置要用于运行函数的 Lambda 函数参数。您可以配置环境变量、消息事件源、超时和容器设置等选项。执行以下操作:

    1. 添加 Lambda 参数对象 (componentLambdaParameters) 到中的 Lambda 函数lambda-function-component.json.

      { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { } } }
    2. (可选)指定 Lambda 函数为工作消息订阅的事件源。您可以指定事件来源以订阅到本地发布/订阅消息。Amazon IoT CoreMQTT 消息。Lambda 函数在收到来自事件源的消息时调用。

      注意

      要将此函数订阅来自其他 Lambda 函数或组件的消息,请部署旧版订阅路由器组件当您部署此 Lambda 函数组件时。当您部署旧版订阅路由器组件时,请指定 Lambda 函数使用的订阅。

      执行以下操作:

      1. 添加事件来源列表 (eventSources) 转到 Lambda 函数参数。

        { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ ] } } }
      2. 将每个事件来源添加到列表中。每个事件源都具有以下参数:

        • topic— 订阅消息的主题。本主题支持 MQTT 主题通配符 (+#) 订阅时Amazon IoT CoreMQTT 主题。

        • type— 事件源的类型。从以下选项中进行选择:

          • PUB_SUB – 订阅本地发布/订阅消息。

          • IOT_CORE— 订阅Amazon IoT CoreMQTT 消息。

          以下示例订阅了Amazon IoT CoreMQTT 关于与hello/world/+主题筛选条件。

          { "topic": "hello/world/+", "type": "IOT_CORE" }

          您的lambda-function-component.json可能与以下示例类似。

          { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ] } } }
    3. (可选)在 Lambda 函数参数对象中指定以下任意参数:

      • environmentVariables— Lambda 函数运行时可用的环境变量映射。

      • execArgs— Lambda 函数运行时要传递给 Lambda 函数时要传递给该函数的参数列表。

      • inputPayloadEncodingType— Lambda 函数支持的负载类型。从以下选项中进行选择:

        • json

        • binary

        默认值:json

      • pinned— Lambda 函数是否已固定。默认为 true

        • 固定(或长时间生存)Lambda 函数在以下时启动。Amazon IoT Greengrass在自己的容器中启动并保持运行。

        • 非固定(或按需)Lambda 函数仅在收到工作项时启动,在空闲时间内空闲时间之后退出。如果该函数有多个工作项,则Amazon IoT Greengrass核心软件将创建该函数的多个实例。

        使用maxIdleTimeInSeconds以设置功能的最长空闲时间。

      • timeoutInSeconds— Lambda 函数超时之前可以运行的最长时间(以秒为单位)。默认值为 3 秒。

      • statusTimeoutInSeconds— Lambda 函数组件向 Lambda 管理器组件发送状态更新的时间间隔(以秒为单位)。此参数仅适用于固定函数。默认值为 60 秒。

      • maxIdleTimeInSeconds— 非固定 Lambda 函数在Amazon IoT Greengrass核心软件会停止其过程。默认值为 60 秒。

      • maxInstancesCount— 非固定 Lambda 函数可以同时运行的最大实例数。默认为 100 个实例。

      • maxQueueSize— Lambda 函数组件的消息队列的最大大小。这些区域有:Amazon IoT Greengrass核心软件将消息存储在 FIFO(先进先出)队列中,直到它可以运行 Lambda 函数来消耗每条消息。默认值为 1,000 条消息。

      您的lambda-function-component.json可能包含类似于以下示例的文档。

      { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ], "environmentVariables": { "LIMIT": "300" }, "execArgs": [ "-d" ], "inputPayloadEncodingType": "json", "pinned": true, "timeoutInSeconds": 120, "statusTimeoutInSeconds": 30, "maxIdleTimeInSeconds": 30, "maxInstancesCount": 50, "maxQueueSize": 500 } } }
    4. (可选)为 Lambda 函数配置容器设置。默认情况下,Lambda 函数在独立运行时环境中运行。Amazon IoT Greengrass核心软件。您还可以选择在没有任何隔离的情况下将 Lambda 函数作为进程运行。如果您在容器中运行 Lambda 函数,则需要配置容器的内存大小以及 Lambda 函数可用的系统资源。执行以下操作:

      1. 添加 Linux 进程参数对象 (linuxProcessParams) 到中的 Lambda 参数对象lambda-function-component.json.

        { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ], "environmentVariables": { "LIMIT": "300" }, "execArgs": [ "-d" ], "inputPayloadEncodingType": "json", "pinned": true, "timeoutInSeconds": 120, "statusTimeoutInSeconds": 30, "maxIdleTimeInSeconds": 30, "maxInstancesCount": 50, "maxQueueSize": 500, "linuxProcessParams": { } } } }
      2. (可选)指定 Lambda 函数是否在容器中运行。添加isolationMode参数到进程参数对象,然后从以下选项中进行选择:

        • GreengrassContainer— Lambda 函数在容器中运行。

        • NoContainer— Lambda 函数作为进程运行,没有任何隔离。

        默认为 GreengrassContainer

      3. (可选)如果在容器中运行 Lambda 函数,则可以配置内存量和系统资源(例如卷和设备)以供容器使用。执行以下操作:

        1. 添加容器参数对象 (containerParams) 到中的 Linux 进程参数对象lambda-function-component.json.

          { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ], "environmentVariables": { "LIMIT": "300" }, "execArgs": [ "-d" ], "inputPayloadEncodingType": "json", "pinned": true, "timeoutInSeconds": 120, "statusTimeoutInSeconds": 30, "maxIdleTimeInSeconds": 30, "maxInstancesCount": 50, "maxQueueSize": 500, "linuxProcessParams": { "containerParams": { } } } } }
        2. (可选)添加memorySizeInKB参数,指定容器的内存大小。默认值为 16,384 KB (16 MB)。

        3. (可选)添加mountROSysfs参数,指定容器是否可以从设备的/sysfolder。默认为 false

        4. (可选)配置容器化 Lambda 函数可以访问的本地卷。当你定义卷时,Amazon IoT Greengrass核心软件将源文件挂载到容器内的目标。执行以下操作:

          1. 添加卷列表 (volumes) 到容器参数。

            { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ], "environmentVariables": { "LIMIT": "300" }, "execArgs": [ "-d" ], "inputPayloadEncodingType": "json", "pinned": true, "timeoutInSeconds": 120, "statusTimeoutInSeconds": 30, "maxIdleTimeInSeconds": 30, "maxInstancesCount": 50, "maxQueueSize": 500, "linuxProcessParams": { "containerParams": { "memorySizeInKB": 32768, "mountROSysfs": true, "volumes": [ ] } } } } }
          2. 将每个卷添加到列表中。每个卷都具有以下参数:

            • sourcePath— 核心设备上源文件夹的路径。

            • destinationPath— 容器中目标文件夹的路径。

            • permission—(可选)从容器访问源文件夹的权限。从以下选项中进行选择:

              • ro— Lambda 函数具有对源文件夹的只读访问权。

              • rw— Lambda 函数具有对源文件夹的读写访问权限。

              默认为 ro

            • addGroupOwner—(可选)是否将运行 Lambda 函数组件的系统组添加为源文件夹的所有者。默认为 false

            您的lambda-function-component.json可能包含类似于以下示例的文档。

            { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ], "environmentVariables": { "LIMIT": "300" }, "execArgs": [ "-d" ], "inputPayloadEncodingType": "json", "pinned": true, "timeoutInSeconds": 120, "statusTimeoutInSeconds": 30, "maxIdleTimeInSeconds": 30, "maxInstancesCount": 50, "maxQueueSize": 500, "linuxProcessParams": { "containerParams": { "memorySizeInKB": 32768, "mountROSysfs": true, "volumes": [ { "sourcePath": "/var/data/src", "destinationPath": "/var/data/dest", "permission": "rw", "addGroupOwner": true } ] } } } } }
        5. (可选)配置容器化 Lambda 函数可以访问的本地系统设备。执行以下操作:

          1. 添加系统设备列表 (devices) 到容器参数。

            { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ], "environmentVariables": { "LIMIT": "300" }, "execArgs": [ "-d" ], "inputPayloadEncodingType": "json", "pinned": true, "timeoutInSeconds": 120, "statusTimeoutInSeconds": 30, "maxIdleTimeInSeconds": 30, "maxInstancesCount": 50, "maxQueueSize": 500, "linuxProcessParams": { "containerParams": { "memorySizeInKB": 32768, "mountROSysfs": true, "volumes": [ { "sourcePath": "/var/data/src", "destinationPath": "/var/data/dest", "permission": "rw", "addGroupOwner": true } ], "devices": [ ] } } } } }
          2. 将每个系统设备添加到列表中。每个系统设备都具有以下参数:

            • path— 核心设备上通往系统设备的路径。

            • permission—(可选)从容器访问系统设备的权限。从以下选项中进行选择:

              • ro— Lambda 函数具有对系统设备的只读访问权。

              • rw— Lambda 函数具有对系统设备的读写访问权限。

              默认为 ro

            • addGroupOwner—(可选)是否将运行 Lambda 函数组件的系统组添加为系统设备的所有者身份运行 Lambda 函数组件的系统组。默认为 false

          您的lambda-function-component.json可能包含类似于以下示例的文档。

          { "lambdaFunction": { "lambdaArn": "arn:aws:lambda:region:account-id:function:HelloWorld:1", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "componentPlatforms": [ { "name": "Linux x86", "attributes": { "os": "linux", "architecture": "x86" } } ], "componentDependencies": { "aws.greengrass.StreamManager": { "versionRequirement": "^1.0.0", "dependencyType": "HARD" } }, "componentLambdaParameters": { "eventSources": [ { "topic": "hello/world/+", "type": "IOT_CORE" } ], "environmentVariables": { "LIMIT": "300" }, "execArgs": [ "-d" ], "inputPayloadEncodingType": "json", "pinned": true, "timeoutInSeconds": 120, "statusTimeoutInSeconds": 30, "maxIdleTimeInSeconds": 30, "maxInstancesCount": 50, "maxQueueSize": 500, "linuxProcessParams": { "containerParams": { "memorySizeInKB": 32768, "mountROSysfs": true, "volumes": [ { "sourcePath": "/var/data/src", "destinationPath": "/var/data/dest", "permission": "rw", "addGroupOwner": true } ], "devices": [ { "path": "/dev/sda3", "permission": "rw", "addGroupOwner": true } ] } } } } }
  7. (可选)添加标签 (tags) 对于组件。有关更多信息,请参阅 标记 Amazon IoT Greengrass Version 2 资源

第 2 步:创建 Lambda 函数组件

  1. 运行以下命令以创建 Lambda 函数组件:lambda-function-component.json.

    aws greengrassv2 create-component-version --cli-input-json file://lambda-function-component.json

    如果请求成功,响应应应该类似于以下示例。

    { "arn": "arn:aws:greengrass:region:123456789012:components:com.example.HelloWorldLambda:versions:1.0.0", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "creationTimestamp": "Mon Dec 15 20:56:34 UTC 2020", "status": { "componentState": "REQUESTED", "message": "NONE", "errors": {} } }

    复制arn从输出中查看下一步中组件的状态。

  2. 创建组件时,其状态为REQUESTED. 然后,Amazon IoT Greengrass验证组件是否可部署。您可以运行以下命令来查询组件状态并验证组件是否可部署。替换arn使用上一步中的 ARN。

    aws greengrassv2 describe-component \ --arn "arn:aws:greengrass:region:account-id:components:com.example.HelloWorldLambda:versions:1.0.0"

    如果组件验证,则响应表明组件状态为DEPLOYABLE.

    { "arn": "arn:aws:greengrass:region:account-id:components:com.example.HelloWorldLambda:versions:1.0.0", "componentName": "com.example.HelloWorldLambda", "componentVersion": "1.0.0", "creationTimestamp": "2020-12-15T20:56:34.376000-08:00", "publisher": "Amazon Lambda", "status": { "componentState": "DEPLOYABLE", "message": "NONE", "errors": {} }, "platforms": [ { "name": "Linux x86", "attributes": { "architecture": "x86", "os": "linux" } } ] }

    在组件之后DEPLOYABLE,可以将 Lambda 函数部署到核心设备。有关更多信息,请参阅部署Amazon IoT Greengrass组件到设备