Interface CfnFunctionDefinition.IFunctionConfigurationProperty

The group-specific configuration settings for a Lambda function.

Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IFunctionConfigurationProperty
Syntax (vb)
Public Interface IFunctionConfigurationProperty
Remarks

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 property type.

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Greengrass;

var variables;

var functionConfigurationProperty = new FunctionConfigurationProperty {
    EncodingType = "encodingType",
    Environment = new EnvironmentProperty {
        AccessSysfs = false,
        Execution = new ExecutionProperty {
            IsolationMode = "isolationMode",
            RunAs = new RunAsProperty {
                Gid = 123,
                Uid = 123
            }
        },
        ResourceAccessPolicies = new [] { new ResourceAccessPolicyProperty {
            ResourceId = "resourceId",

            // the properties below are optional
            Permission = "permission"
        } },
        Variables = variables
    },
    ExecArgs = "execArgs",
    Executable = "executable",
    MemorySize = 123,
    Pinned = false,
    Timeout = 123
};

Synopsis

Properties

EncodingType

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

The environment configuration of the function.
ExecArgs

The execution arguments.
Executable

The name of the function executable.
MemorySize

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

Indicates whether the function is pinned (or long-lived ).
Timeout

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

Properties

EncodingType

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

virtual string EncodingType { get; }
Property Value

System.String

Remarks

Valid values are json (default) and binary .

See: 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.

virtual object Environment { get; }
Property Value

System.Object

Remarks

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

ExecArgs

The execution arguments.

virtual string ExecArgs { get; }
Property Value

System.String

Remarks

See: 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.

virtual string Executable { get; }
Property Value

System.String

Remarks

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

MemorySize

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

virtual Nullable<double> MemorySize { get; }
Property Value

System.Nullable<System.Double>

Remarks

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

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

virtual object Pinned { get; }
Property Value

System.Object

Remarks

Pinned functions start when the core starts and process all requests in the same container. The default value is false.

See: 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.

virtual Nullable<double> Timeout { get; }
Property Value

System.Nullable<System.Double>

Remarks

For pinned functions, this timeout applies for each request.

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