Interface CfnFunctionDefinition.IFunctionProperty
A function is a Lambda function that's referenced from an AWS IoT Greengrass group.
Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.AWS.Greengrass.dll
Syntax (csharp)
public interface IFunctionProperty
Syntax (vb)
Public Interface IFunctionProperty
Remarks
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 FunctionDefinitionVersion
property type contains a list of Function
property types.
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 functionProperty = new FunctionProperty {
FunctionArn = "functionArn",
FunctionConfiguration = 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
},
Id = "id"
};
Synopsis
Properties
FunctionArn | The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function. |
FunctionConfiguration | The group-specific settings of the Lambda function. |
Id | A descriptive or arbitrary ID for the function. |
Properties
FunctionArn
The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.
string FunctionArn { get; }
Property Value
System.String
Remarks
FunctionConfiguration
The group-specific settings of the Lambda function.
object FunctionConfiguration { get; }
Property Value
System.Object
Remarks
These settings configure the function's behavior in the Greengrass group.
Id
A descriptive or arbitrary ID for the function.
string Id { get; }
Property Value
System.String
Remarks
This value must be unique within the function definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+
.