CfnFunctionDefinition

class aws_cdk.aws_greengrass.CfnFunctionDefinition(scope, id, *, name, initial_version=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::Greengrass::FunctionDefinition.

The AWS::Greengrass::FunctionDefinition resource represents a function definition for AWS IoT Greengrass . Function definitions are used to organize your function definition versions.

Function definitions can reference multiple function definition versions. All function definition versions must be associated with a function definition. Each function definition version can contain one or more functions. .. epigraph:

When you create a function definition, you can optionally include an initial function definition version. To associate a function definition version later, create an ```AWS::Greengrass::FunctionDefinitionVersion`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html>`_ resource and specify the ID of this function definition.

After you create the function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see ```AWS::Greengrass::Group`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html>`_ .
CloudformationResource:

AWS::Greengrass::FunctionDefinition

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

# tags: Any
# variables: Any

cfn_function_definition = greengrass.CfnFunctionDefinition(self, "MyCfnFunctionDefinition",
    name="name",

    # the properties below are optional
    initial_version=greengrass.CfnFunctionDefinition.FunctionDefinitionVersionProperty(
        functions=[greengrass.CfnFunctionDefinition.FunctionProperty(
            function_arn="functionArn",
            function_configuration=greengrass.CfnFunctionDefinition.FunctionConfigurationProperty(
                encoding_type="encodingType",
                environment=greengrass.CfnFunctionDefinition.EnvironmentProperty(
                    access_sysfs=False,
                    execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
                        isolation_mode="isolationMode",
                        run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
                            gid=123,
                            uid=123
                        )
                    ),
                    resource_access_policies=[greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty(
                        resource_id="resourceId",

                        # the properties below are optional
                        permission="permission"
                    )],
                    variables=variables
                ),
                exec_args="execArgs",
                executable="executable",
                memory_size=123,
                pinned=False,
                timeout=123
            ),
            id="id"
        )],

        # the properties below are optional
        default_config=greengrass.CfnFunctionDefinition.DefaultConfigProperty(
            execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
                isolation_mode="isolationMode",
                run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
                    gid=123,
                    uid=123
                )
            )
        )
    ),
    tags=tags
)

Create a new AWS::Greengrass::FunctionDefinition.

Parameters:

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Greengrass::FunctionDefinition'
attr_arn

The Amazon Resource Name (ARN) of the FunctionDefinition , such as arn:aws:greengrass:us-east-1:  :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

CloudformationAttribute:

Arn

attr_id

The ID of the FunctionDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

CloudformationAttribute:

Id

attr_latest_version_arn

The ARN of the last FunctionDefinitionVersion that was added to the FunctionDefinition , such as arn:aws:greengrass:us-east-1:  :/greengrass/definition/functions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2 .

CloudformationAttribute:

LatestVersionArn

attr_name

The name of the FunctionDefinition , such as MyFunctionDefinition .

CloudformationAttribute:

Name

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

initial_version

The function definition version to include when the function definition is created.

A function definition version contains a list of `function <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html>`_ property types. .. epigraph:

To associate a function definition version after the function definition is created, create an ```AWS::Greengrass::FunctionDefinitionVersion`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html>`_ resource and specify the ID of this function definition.
Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-initialversion

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the function definition.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-name

node

The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Application-specific metadata to attach to the function definition.

You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates:

"Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
}
Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html#cfn-greengrass-functiondefinition-tags

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct)

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any)

Return type:

bool

DefaultConfigProperty

class CfnFunctionDefinition.DefaultConfigProperty(*, execution)

Bases: object

The default configuration that applies to all Lambda functions in the function definition version.

Individual Lambda functions can override these settings.

In an AWS CloudFormation template, DefaultConfig is a property of the `FunctionDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html>`_ property type.

Parameters:

execution (Union[IResolvable, ExecutionProperty, Dict[str, Any]]) – Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

default_config_property = greengrass.CfnFunctionDefinition.DefaultConfigProperty(
    execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
        isolation_mode="isolationMode",
        run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
            gid=123,
            uid=123
        )
    )
)

Attributes

execution

Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html#cfn-greengrass-functiondefinition-defaultconfig-execution

EnvironmentProperty

class CfnFunctionDefinition.EnvironmentProperty(*, access_sysfs=None, execution=None, resource_access_policies=None, variables=None)

Bases: object

The environment configuration for a Lambda function on the AWS IoT Greengrass core.

In an AWS CloudFormation template, Environment is a property of the `FunctionConfiguration <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html>`_ property type.

Parameters:

  • access_sysfs (Union[bool, IResolvable, None]) – Indicates whether the function is allowed to access the /sys directory on the core device, which allows the read device information from /sys . .. epigraph:: This property applies only to Lambda functions that run in a Greengrass container.

  • execution (Union[IResolvable, ExecutionProperty, Dict[str, Any], None]) – Settings for the Lambda execution environment in AWS IoT Greengrass .

  • resource_access_policies (Union[IResolvable, Sequence[Union[IResolvable, ResourceAccessPolicyProperty, Dict[str, Any]]], None]) – A list of the resources in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources. .. epigraph:: This property applies only for Lambda functions that run in a Greengrass container.

  • variables (Optional[Any]) – Environment variables for the Lambda function.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

# variables: Any

environment_property = greengrass.CfnFunctionDefinition.EnvironmentProperty(
    access_sysfs=False,
    execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
        isolation_mode="isolationMode",
        run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
            gid=123,
            uid=123
        )
    ),
    resource_access_policies=[greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty(
        resource_id="resourceId",

        # the properties below are optional
        permission="permission"
    )],
    variables=variables
)

Attributes

access_sysfs

Indicates whether the function is allowed to access the /sys directory on the core device, which allows the read device information from /sys .

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-accesssysfs

execution

Settings for the Lambda execution environment in AWS IoT Greengrass .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-execution

resource_access_policies

A list of the resources in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources.

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-resourceaccesspolicies

variables

Environment variables for the Lambda function.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html#cfn-greengrass-functiondefinition-environment-variables

ExecutionProperty

class CfnFunctionDefinition.ExecutionProperty(*, isolation_mode=None, run_as=None)

Bases: object

Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.

In an AWS CloudFormation template, Execution is a property of the `DefaultConfig <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-defaultconfig.html>`_ property type for a function definition version and the `Environment <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html>`_ property type for a function.

Parameters:
Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

execution_property = greengrass.CfnFunctionDefinition.ExecutionProperty(
    isolation_mode="isolationMode",
    run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
        gid=123,
        uid=123
    )
)

Attributes

isolation_mode

The containerization that the Lambda function runs in.

Valid values are GreengrassContainer or NoContainer . Typically, this is GreengrassContainer . For more information, see Containerization in the Developer Guide .

We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-isolationmode

run_as

The user and group permissions used to run the Lambda function.

Typically, this is the ggc_user and ggc_group. For more information, see Run as in the Developer Guide .

Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see Running a Lambda Function as Root .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html#cfn-greengrass-functiondefinition-execution-runas

FunctionConfigurationProperty

class CfnFunctionDefinition.FunctionConfigurationProperty(*, encoding_type=None, environment=None, exec_args=None, executable=None, memory_size=None, pinned=None, timeout=None)

Bases: object

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 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html>`_ property type.

Parameters:

  • encoding_type (Optional[str]) – The expected encoding type of the input payload for the function. Valid values are json (default) and binary .

  • environment (Union[IResolvable, EnvironmentProperty, Dict[str, Any], None]) – The environment configuration of the function.

  • exec_args (Optional[str]) – The execution arguments.

  • executable (Optional[str]) – The name of the function executable.

  • memory_size (Union[int, float, None]) – The memory size (in KB) required by the function. .. epigraph:: This property applies only to Lambda functions that run in a Greengrass container.

  • pinned (Union[bool, IResolvable, None]) – 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 (Union[int, float, None]) – The allowed execution time (in seconds) after which the function should terminate. For pinned functions, this timeout applies for each request.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

# variables: Any

function_configuration_property = greengrass.CfnFunctionDefinition.FunctionConfigurationProperty(
    encoding_type="encodingType",
    environment=greengrass.CfnFunctionDefinition.EnvironmentProperty(
        access_sysfs=False,
        execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
            isolation_mode="isolationMode",
            run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
                gid=123,
                uid=123
            )
        ),
        resource_access_policies=[greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty(
            resource_id="resourceId",

            # the properties below are optional
            permission="permission"
        )],
        variables=variables
    ),
    exec_args="execArgs",
    executable="executable",
    memory_size=123,
    pinned=False,
    timeout=123
)

Attributes

encoding_type

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

Valid values are json (default) and binary .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-encodingtype

environment

The environment configuration of the function.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-environment

exec_args

The execution arguments.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-execargs

executable

The name of the function executable.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-executable

memory_size

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

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-memorysize

pinned

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-pinned

timeout

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

For pinned functions, this timeout applies for each request.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functionconfiguration.html#cfn-greengrass-functiondefinition-functionconfiguration-timeout

FunctionDefinitionVersionProperty

class CfnFunctionDefinition.FunctionDefinitionVersionProperty(*, functions, default_config=None)

Bases: object

A function definition version contains a list of functions.

After you create a function definition version that contains the functions you want to deploy, you must add it to your group version. For more information, see `AWS::Greengrass::Group <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html>`_ .

In an AWS CloudFormation template, FunctionDefinitionVersion is the property type of the InitialVersion property in the `AWS::Greengrass::FunctionDefinition <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html>`_ resource.

Parameters:

  • functions (Union[IResolvable, Sequence[Union[IResolvable, FunctionProperty, Dict[str, Any]]]]) – The functions in this version.

  • default_config (Union[IResolvable, DefaultConfigProperty, Dict[str, Any], None]) – The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

# variables: Any

function_definition_version_property = greengrass.CfnFunctionDefinition.FunctionDefinitionVersionProperty(
    functions=[greengrass.CfnFunctionDefinition.FunctionProperty(
        function_arn="functionArn",
        function_configuration=greengrass.CfnFunctionDefinition.FunctionConfigurationProperty(
            encoding_type="encodingType",
            environment=greengrass.CfnFunctionDefinition.EnvironmentProperty(
                access_sysfs=False,
                execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
                    isolation_mode="isolationMode",
                    run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
                        gid=123,
                        uid=123
                    )
                ),
                resource_access_policies=[greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty(
                    resource_id="resourceId",

                    # the properties below are optional
                    permission="permission"
                )],
                variables=variables
            ),
            exec_args="execArgs",
            executable="executable",
            memory_size=123,
            pinned=False,
            timeout=123
        ),
        id="id"
    )],

    # the properties below are optional
    default_config=greengrass.CfnFunctionDefinition.DefaultConfigProperty(
        execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
            isolation_mode="isolationMode",
            run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
                gid=123,
                uid=123
            )
        )
    )
)

Attributes

default_config

The default configuration that applies to all Lambda functions in the group.

Individual Lambda functions can override these settings.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-defaultconfig

functions

The functions in this version.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html#cfn-greengrass-functiondefinition-functiondefinitionversion-functions

FunctionProperty

class CfnFunctionDefinition.FunctionProperty(*, function_arn, function_configuration, id)

Bases: object

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 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-functiondefinitionversion.html>`_ property type contains a list of Function property types.

Parameters:

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

  • function_configuration (Union[IResolvable, FunctionConfigurationProperty, Dict[str, Any]]) – The group-specific settings of the Lambda function. These settings configure the function’s behavior in the Greengrass group.

  • id (str) – 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:_-]+ .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

# variables: Any

function_property = greengrass.CfnFunctionDefinition.FunctionProperty(
    function_arn="functionArn",
    function_configuration=greengrass.CfnFunctionDefinition.FunctionConfigurationProperty(
        encoding_type="encodingType",
        environment=greengrass.CfnFunctionDefinition.EnvironmentProperty(
            access_sysfs=False,
            execution=greengrass.CfnFunctionDefinition.ExecutionProperty(
                isolation_mode="isolationMode",
                run_as=greengrass.CfnFunctionDefinition.RunAsProperty(
                    gid=123,
                    uid=123
                )
            ),
            resource_access_policies=[greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty(
                resource_id="resourceId",

                # the properties below are optional
                permission="permission"
            )],
            variables=variables
        ),
        exec_args="execArgs",
        executable="executable",
        memory_size=123,
        pinned=False,
        timeout=123
    ),
    id="id"
)

Attributes

function_arn

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionarn

function_configuration

The group-specific settings of the Lambda function.

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-functionconfiguration

id

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:_-]+ .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html#cfn-greengrass-functiondefinition-function-id

ResourceAccessPolicyProperty

class CfnFunctionDefinition.ResourceAccessPolicyProperty(*, resource_id, permission=None)

Bases: object

A list of the resources in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources.

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

In an AWS CloudFormation template, ResourceAccessPolicy is a property of the `Environment <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-environment.html>`_ property type.

Parameters:

  • resource_id (str) – The ID of the resource. This ID is assigned to the resource when you create the resource definition.

  • permission (Optional[str]) – The read-only or read-write access that the Lambda function has to the resource. Valid values are ro or rw .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

resource_access_policy_property = greengrass.CfnFunctionDefinition.ResourceAccessPolicyProperty(
    resource_id="resourceId",

    # the properties below are optional
    permission="permission"
)

Attributes

permission

The read-only or read-write access that the Lambda function has to the resource.

Valid values are ro or rw .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-permission

resource_id

The ID of the resource.

This ID is assigned to the resource when you create the resource definition.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-resourceaccesspolicy.html#cfn-greengrass-functiondefinition-resourceaccesspolicy-resourceid

RunAsProperty

class CfnFunctionDefinition.RunAsProperty(*, gid=None, uid=None)

Bases: object

The access identity whose permissions are used to run the Lambda function.

This setting overrides the default access identity that’s specified for the group (by default, ggc_user and ggc_group). You can override the user, group, or both. For more information, see Run as in the Developer Guide . .. epigraph:

Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see `Running a Lambda Function as Root <https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root>`_ .

In an AWS CloudFormation template, RunAs is a property of the `Execution <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-execution.html>`_ property type.

Parameters:

  • gid (Union[int, float, None]) – The group ID whose permissions are used to run the Lambda function. You can use the getent group command on your core device to look up the group ID.

  • uid (Union[int, float, None]) – The user ID whose permissions are used to run the Lambda function. You can use the getent passwd command on your core device to look up the user ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrass as greengrass

run_as_property = greengrass.CfnFunctionDefinition.RunAsProperty(
    gid=123,
    uid=123
)

Attributes

gid

The group ID whose permissions are used to run the Lambda function.

You can use the getent group command on your core device to look up the group ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-gid

uid

The user ID whose permissions are used to run the Lambda function.

You can use the getent passwd command on your core device to look up the user ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-runas.html#cfn-greengrass-functiondefinition-runas-uid