CfnFunctionDefinitionProps

class aws_cdk.aws_greengrass.CfnFunctionDefinitionProps(*, name, initial_version=None, tags=None)

Bases: object

Properties for defining a CfnFunctionDefinition.

Parameters
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_props = greengrass.CfnFunctionDefinitionProps(
    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
)

Attributes

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

Return type

Union[IResolvable, FunctionDefinitionVersionProperty, None]

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

Return type

str

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

Return type

Any