CfnFunctionDefinitionVersion

class aws_cdk.aws_greengrass.CfnFunctionDefinitionVersion(scope, id, *, function_definition_id, functions, default_config=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Greengrass::FunctionDefinitionVersion.

The AWS::Greengrass::FunctionDefinitionVersion resource represents a function definition version for AWS IoT Greengrass . A function definition version contains contain a list of functions. .. epigraph:

To create a function definition version, you must specify the ID of the function definition that you want to associate with the version. For information about creating a function definition, see ```AWS::Greengrass::FunctionDefinition`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinition.html>`_ .

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>`_ .
CloudformationResource

AWS::Greengrass::FunctionDefinitionVersion

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-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

cfn_function_definition_version = greengrass.CfnFunctionDefinitionVersion(self, "MyCfnFunctionDefinitionVersion",
    function_definition_id="functionDefinitionId",
    functions=[greengrass.CfnFunctionDefinitionVersion.FunctionProperty(
        function_arn="functionArn",
        function_configuration=greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty(
            encoding_type="encodingType",
            environment=greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty(
                access_sysfs=False,
                execution=greengrass.CfnFunctionDefinitionVersion.ExecutionProperty(
                    isolation_mode="isolationMode",
                    run_as=greengrass.CfnFunctionDefinitionVersion.RunAsProperty(
                        gid=123,
                        uid=123
                    )
                ),
                resource_access_policies=[greengrass.CfnFunctionDefinitionVersion.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.CfnFunctionDefinitionVersion.DefaultConfigProperty(
        execution=greengrass.CfnFunctionDefinitionVersion.ExecutionProperty(
            isolation_mode="isolationMode",
            run_as=greengrass.CfnFunctionDefinitionVersion.RunAsProperty(
                gid=123,
                uid=123
            )
        )
    )
)

Create a new AWS::Greengrass::FunctionDefinitionVersion.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • function_definition_id (str) – The ID of the function definition associated with this version. This value is a GUID.

  • 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.

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

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.

Return type

None

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

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.

Return type

Any

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::FunctionDefinitionVersion'
cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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.

Return type

List[str]

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-resource-greengrass-functiondefinitionversion.html#cfn-greengrass-functiondefinitionversion-defaultconfig

Return type

Union[IResolvable, DefaultConfigProperty, None]

function_definition_id

The ID of the function definition associated with this version.

This value is a GUID.

Link

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

Return type

str

functions

The functions in this version.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, FunctionProperty]]]

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).

Return type

str

Returns

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

node

The construct tree node associated with this construct.

Return type

ConstructNode

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 }).

Return type

str

stack

The stack in which this element is defined.

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

Return type

Stack

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 CfnFunctionDefinitionVersion.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 `AWS::Greengrass::FunctionDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html>`_ resource.

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-functiondefinitionversion-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.CfnFunctionDefinitionVersion.DefaultConfigProperty(
    execution=greengrass.CfnFunctionDefinitionVersion.ExecutionProperty(
        isolation_mode="isolationMode",
        run_as=greengrass.CfnFunctionDefinitionVersion.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-functiondefinitionversion-defaultconfig.html#cfn-greengrass-functiondefinitionversion-defaultconfig-execution

Return type

Union[IResolvable, ExecutionProperty]

EnvironmentProperty

class CfnFunctionDefinitionVersion.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-functiondefinitionversion-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 to 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-functiondefinitionversion-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.CfnFunctionDefinitionVersion.EnvironmentProperty(
    access_sysfs=False,
    execution=greengrass.CfnFunctionDefinitionVersion.ExecutionProperty(
        isolation_mode="isolationMode",
        run_as=greengrass.CfnFunctionDefinitionVersion.RunAsProperty(
            gid=123,
            uid=123
        )
    ),
    resource_access_policies=[greengrass.CfnFunctionDefinitionVersion.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-functiondefinitionversion-environment.html#cfn-greengrass-functiondefinitionversion-environment-accesssysfs

Return type

Union[bool, IResolvable, None]

execution

Settings for the Lambda execution environment in AWS IoT Greengrass .

Link

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

Return type

Union[IResolvable, ExecutionProperty, None]

resource_access_policies

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html>`_ 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.

Link

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

Type

A list of the `resources <https

Return type

Union[IResolvable, List[Union[IResolvable, ResourceAccessPolicyProperty]], None]

variables

Environment variables for the Lambda function.

Link

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

Return type

Any

ExecutionProperty

class CfnFunctionDefinitionVersion.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-functiondefinitionversion-defaultconfig.html>`_ property type for a function definition version and the `Environment <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html>`_ property type for a function.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-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.CfnFunctionDefinitionVersion.ExecutionProperty(
    isolation_mode="isolationMode",
    run_as=greengrass.CfnFunctionDefinitionVersion.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-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-isolationmode

Return type

Optional[str]

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-functiondefinitionversion-execution.html#cfn-greengrass-functiondefinitionversion-execution-runas

Return type

Union[IResolvable, RunAsProperty, None]

FunctionConfigurationProperty

class CfnFunctionDefinitionVersion.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-functiondefinitionversion-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-functiondefinitionversion-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.CfnFunctionDefinitionVersion.FunctionConfigurationProperty(
    encoding_type="encodingType",
    environment=greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty(
        access_sysfs=False,
        execution=greengrass.CfnFunctionDefinitionVersion.ExecutionProperty(
            isolation_mode="isolationMode",
            run_as=greengrass.CfnFunctionDefinitionVersion.RunAsProperty(
                gid=123,
                uid=123
            )
        ),
        resource_access_policies=[greengrass.CfnFunctionDefinitionVersion.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-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-encodingtype

Return type

Optional[str]

environment

The environment configuration of the function.

Link

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

Return type

Union[IResolvable, EnvironmentProperty, None]

exec_args

The execution arguments.

Link

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

Return type

Optional[str]

executable

The name of the function executable.

Link

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

Return type

Optional[str]

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-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-memorysize

Return type

Union[int, float, None]

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-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-pinned

Return type

Union[bool, IResolvable, None]

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-functiondefinitionversion-functionconfiguration.html#cfn-greengrass-functiondefinitionversion-functionconfiguration-timeout

Return type

Union[int, float, None]

FunctionProperty

class CfnFunctionDefinitionVersion.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 `AWS::Greengrass::FunctionDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html>`_ resource 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-functiondefinitionversion-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.CfnFunctionDefinitionVersion.FunctionProperty(
    function_arn="functionArn",
    function_configuration=greengrass.CfnFunctionDefinitionVersion.FunctionConfigurationProperty(
        encoding_type="encodingType",
        environment=greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty(
            access_sysfs=False,
            execution=greengrass.CfnFunctionDefinitionVersion.ExecutionProperty(
                isolation_mode="isolationMode",
                run_as=greengrass.CfnFunctionDefinitionVersion.RunAsProperty(
                    gid=123,
                    uid=123
                )
            ),
            resource_access_policies=[greengrass.CfnFunctionDefinitionVersion.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-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionarn

Return type

str

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-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-functionconfiguration

Return type

Union[IResolvable, FunctionConfigurationProperty]

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-functiondefinitionversion-function.html#cfn-greengrass-functiondefinitionversion-function-id

Return type

str

ResourceAccessPolicyProperty

class CfnFunctionDefinitionVersion.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-functiondefinitionversion-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-functiondefinitionversion-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.CfnFunctionDefinitionVersion.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-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-permission

Return type

Optional[str]

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-functiondefinitionversion-resourceaccesspolicy.html#cfn-greengrass-functiondefinitionversion-resourceaccesspolicy-resourceid

Return type

str

RunAsProperty

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

Bases: object

The user and group permissions 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-functiondefinitionversion-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-functiondefinitionversion-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.CfnFunctionDefinitionVersion.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-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-gid

Return type

Union[int, float, None]

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-functiondefinitionversion-runas.html#cfn-greengrass-functiondefinitionversion-runas-uid

Return type

Union[int, float, None]