function_definitions

Creates, updates, deletes, gets or lists a function_definitions resource.

Overview

Name	function_definitions
Type	Resource
Id	aws.greengrass.function_definitions

Fields

The following fields are returned by SELECT queries:

get_function_definition

Name	Datatype	Description
arn	string	The ARN of the definition.
creation_timestamp	string	The time, in milliseconds since the epoch, when the definition was created.
id	string	The ID of the definition.
last_updated_timestamp	string	The time, in milliseconds since the epoch, when the definition was last updated.
latest_version	string	The ID of the latest version associated with the definition.
latest_version_arn	string	The ARN of the latest version associated with the definition.
name	string	The name of the definition.
tags	object	Tag(s) attached to the resource arn.

list_function_definitions

Name	Datatype	Description
arn	string	The ARN of the definition.
creation_timestamp	string	The time, in milliseconds since the epoch, when the definition was created.
id	string	The ID of the definition.
last_updated_timestamp	string	The time, in milliseconds since the epoch, when the definition was last updated.
latest_version	string	The ID of the latest version associated with the definition.
latest_version_arn	string	The ARN of the latest version associated with the definition.
name	string	The name of the definition.
tags	object	Tag(s) attached to the resource arn.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_function_definition	select	function_definition_id, region		Retrieves information about a Lambda function definition, including its creation time and latest version.
list_function_definitions	select	region	MaxResults, NextToken	Retrieves a list of Lambda function definitions.
create_function_definition	insert	region	X-Amzn-Client-Token	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.
update_function_definition	update	function_definition_id, region		Updates a Lambda function definition.
delete_function_definition	delete	function_definition_id, region		Deletes a Lambda function definition.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
function_definition_id	string	The ID of the Lambda function definition.
region	string	AWS region (default: us-east-1)
MaxResults	string	The maximum number of results to be returned per request.
NextToken	string	The token for the next set of results, or ''null'' if there are no additional results.
X-Amzn-Client-Token	string	A client token used to correlate requests and responses.

SELECT examples

get_function_definition

Retrieves information about a Lambda function definition, including its creation time and latest version.

SELECT
arn,
creation_timestamp,
id,
last_updated_timestamp,
latest_version,
latest_version_arn,
name,
tags
FROM aws.greengrass.function_definitions
WHERE function_definition_id = '{{ function_definition_id }}' -- required
AND region = '{{ region }}' -- required
;

list_function_definitions

Retrieves a list of Lambda function definitions.

SELECT
arn,
creation_timestamp,
id,
last_updated_timestamp,
latest_version,
latest_version_arn,
name,
tags
FROM aws.greengrass.function_definitions
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_function_definition

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.

INSERT INTO aws.greengrass.function_definitions (
InitialVersion,
Name,
tags,
region,
`X-Amzn-Client-Token`
)
SELECT 
'{{ InitialVersion }}',
'{{ Name }}',
'{{ tags }}',
'{{ region }}',
'{{ X-Amzn-Client-Token }}'
RETURNING
arn,
creation_timestamp,
id,
last_updated_timestamp,
latest_version,
latest_version_arn,
name
;

Manifest

# Description fields are for documentation purposes
- name: function_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the function_definitions resource.
  - name: InitialVersion
    description: |
      Information about a function definition version.
    value:
      DefaultConfig:
        Execution:
          IsolationMode: "{{ IsolationMode }}"
          RunAs:
            Gid: {{ Gid }}
            Uid: {{ Uid }}
      Functions:
        - FunctionArn: "{{ FunctionArn }}"
          FunctionConfiguration:
            EncodingType: "{{ EncodingType }}"
            Environment:
              AccessSysfs: {{ AccessSysfs }}
              Execution:
                IsolationMode: "{{ IsolationMode }}"
                RunAs: "{{ RunAs }}"
              ResourceAccessPolicies:
                - Permission: "{{ Permission }}"
                  ResourceId: "{{ ResourceId }}"
              Variables: "{{ Variables }}"
            ExecArgs: "{{ ExecArgs }}"
            Executable: "{{ Executable }}"
            MemorySize: {{ MemorySize }}
            Pinned: {{ Pinned }}
            Timeout: {{ Timeout }}
            FunctionRuntimeOverride: "{{ FunctionRuntimeOverride }}"
          Id: "{{ Id }}"
  - name: Name
    value: "{{ Name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The key-value pair for the resource tag.
  - name: X-Amzn-Client-Token
    value: "{{ X-Amzn-Client-Token }}"
    description: A client token used to correlate requests and responses.
    description: A client token used to correlate requests and responses.

UPDATE examples

update_function_definition

Updates a Lambda function definition.

UPDATE aws.greengrass.function_definitions
SET 
Name = '{{ Name }}'
WHERE 
function_definition_id = '{{ function_definition_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_function_definition

Deletes a Lambda function definition.

DELETE FROM aws.greengrass.function_definitions
WHERE function_definition_id = '{{ function_definition_id }}' --required
AND region = '{{ region }}' --required
;