Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . greengrass ]

create-function-definition

Description

Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-function-definition
[--amzn-client-token <value>]
[--initial-version <value>]
[--name <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--amzn-client-token (string) A client token used to correlate requests and responses.

--initial-version (structure) Information about the initial version of the function definition.

JSON Syntax:

{
  "DefaultConfig": {
    "Execution": {
      "IsolationMode": "GreengrassContainer"|"NoContainer",
      "RunAs": {
        "Gid": integer,
        "Uid": integer
      }
    }
  },
  "Functions": [
    {
      "FunctionArn": "string",
      "FunctionConfiguration": {
        "EncodingType": "binary"|"json",
        "Environment": {
          "AccessSysfs": true|false,
          "Execution": {
            "IsolationMode": "GreengrassContainer"|"NoContainer",
            "RunAs": {
              "Gid": integer,
              "Uid": integer
            }
          },
          "ResourceAccessPolicies": [
            {
              "Permission": "ro"|"rw",
              "ResourceId": "string"
            }
            ...
          ],
          "Variables": {"string": "string"
            ...}
        },
        "ExecArgs": "string",
        "Executable": "string",
        "MemorySize": integer,
        "Pinned": true|false,
        "Timeout": integer
      },
      "Id": "string"
    }
    ...
  ]
}

--name (string) The name of the function definition.

--tags (map) Tag(s) to add to the new resource.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a Lambda function definition

The following create-function-definition example creates a Lambda function definition and an initial version by providing a list of Lambda functions (in this case, a list of just one function named TempMonitorFunction) and their configurations. Before you can create the function definition, you need the Lambda function ARN. To create the function and its alias, use Lambda's create-function and publish-version commands. Lambda's create-function command requires the ARN of the execution role, even though AWS IoT Greengrass doesn't use that role because permissions are specified in the Greengrass group role. You can use the IAM create-role command to create an empty role to get an ARN to use with Lambda's create-function or you can use an existing execution role.

aws greengrass create-function-definition \
    --name MyGreengrassFunctions \
    --initial-version "{\"Functions\": [{\"Id\": \"TempMonitorFunction\", \"FunctionArn\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"FunctionConfiguration\": {\"Executable\": \"temp_monitor.function_handler\", \"MemorySize\": 16000,\"Timeout\": 5}}]}"

Output:

{
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b",
    "CreationTimestamp": "2019-06-19T22:24:44.585Z",
    "Id": "3b0d0080-87e7-48c6-b182-503ec743a08b",
    "LastUpdatedTimestamp": "2019-06-19T22:24:44.585Z",
    "LatestVersion": "67f918b9-efb4-40b0-b87c-de8c9faf085b",
    "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b/versions/67f918b9-efb4-40b0-b87c-de8c9faf085b",
    "Name": "MyGreengrassFunctions"
}

For more information, see How to Configure Local Resource Access Using the AWS Command Line Interface in the AWS IoT Greengrass Developer Guide.

Output

Arn -> (string)

The ARN of the definition.

CreationTimestamp -> (string)

The time, in milliseconds since the epoch, when the definition was created.

Id -> (string)

The ID of the definition.

LastUpdatedTimestamp -> (string)

The time, in milliseconds since the epoch, when the definition was last updated.

LatestVersion -> (string)

The ID of the latest version associated with the definition.

LatestVersionArn -> (string)

The ARN of the latest version associated with the definition.

Name -> (string)

The name of the definition.