Skip to content

FunctionConfiguration

Source code in docs_src/capo_greengrass/types/function_configuration.py
class FunctionConfiguration(TypedDict, closed=True):
    encoding_type: NotRequired["capo_greengrass.types.encoding_type.EncodingType"]
    """The expected encoding type of the input payload for the function. The default is ''json''."""
    environment: NotRequired[
        "capo_greengrass.types.function_configuration_environment.FunctionConfigurationEnvironment"
    ]
    """The environment configuration of the function."""
    exec_args: NotRequired["capo_greengrass.types.__string.__string"]
    """The execution arguments."""
    executable: NotRequired["capo_greengrass.types.__string.__string"]
    """The name of the function executable."""
    memory_size: NotRequired["capo_greengrass.types.__integer.__integer"]
    """The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization."""
    pinned: NotRequired["capo_greengrass.types.__boolean.__boolean"]
    """True if the function is pinned. Pinned means the function is long-lived and starts when the core starts."""
    timeout: NotRequired["capo_greengrass.types.__integer.__integer"]
    """The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request."""
    function_runtime_override: NotRequired["capo_greengrass.types.__string.__string"]
    """The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function."""

encoding_type instance-attribute

encoding_type: NotRequired[EncodingType]

The expected encoding type of the input payload for the function. The default is ''json''.

environment instance-attribute

environment: NotRequired[FunctionConfigurationEnvironment]

The environment configuration of the function.

exec_args instance-attribute

exec_args: NotRequired[__string]

The execution arguments.

executable instance-attribute

executable: NotRequired[__string]

The name of the function executable.

function_runtime_override instance-attribute

function_runtime_override: NotRequired[__string]

The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.

memory_size instance-attribute

memory_size: NotRequired[__integer]

The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.

pinned instance-attribute

pinned: NotRequired[__boolean]

True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.

timeout instance-attribute

timeout: NotRequired[__integer]

The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.