Class CfnFunctionDefinitionVersion.FunctionConfigurationProperty
The group-specific configuration settings for a Lambda function.
Inheritance
Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FunctionConfigurationProperty : Object, CfnFunctionDefinitionVersion.IFunctionConfigurationProperty
Syntax (vb)
Public Class FunctionConfigurationProperty
Inherits Object
Implements CfnFunctionDefinitionVersion.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.
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
Constructors
FunctionConfigurationProperty() |
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. |
Constructors
FunctionConfigurationProperty()
public FunctionConfigurationProperty()
Properties
EncodingType
The expected encoding type of the input payload for the function.
public string EncodingType { get; set; }
Property Value
System.String
Remarks
Environment
The environment configuration of the function.
public object Environment { get; set; }
Property Value
System.Object
Remarks
ExecArgs
The execution arguments.
public string ExecArgs { get; set; }
Property Value
System.String
Remarks
Executable
The name of the function executable.
public string Executable { get; set; }
Property Value
System.String
Remarks
MemorySize
The memory size (in KB) required by the function.
public Nullable<double> MemorySize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This property applies only to Lambda functions that run in a Greengrass container.
Pinned
Indicates whether the function is pinned (or long-lived ).
public object Pinned { get; set; }
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.
Timeout
The allowed execution time (in seconds) after which the function should terminate.
public Nullable<double> Timeout { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For pinned functions, this timeout applies for each request.