1.204.0

interface ExecutionProperty

LanguageType name
.NETAmazon.CDK.AWS.Greengrass.CfnFunctionDefinition.ExecutionProperty
Javasoftware.amazon.awscdk.services.greengrass.CfnFunctionDefinition.ExecutionProperty
Pythonaws_cdk.aws_greengrass.CfnFunctionDefinition.ExecutionProperty
TypeScript @aws-cdk/aws-greengrass » CfnFunctionDefinition » ExecutionProperty

Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core.

In an AWS CloudFormation template, Execution is a property of the DefaultConfig property type for a function definition version and the Environment property type for a function.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as greengrass from '@aws-cdk/aws-greengrass';
const executionProperty: greengrass.CfnFunctionDefinition.ExecutionProperty = {
  isolationMode: 'isolationMode',
  runAs: {
    gid: 123,
    uid: 123,
  },
};

Properties

NameTypeDescription
isolationMode?stringThe containerization that the Lambda function runs in.
runAs?IResolvable | RunAsPropertyThe user and group permissions used to run the Lambda function.

isolationMode?

Type: string (optional)

The containerization that the Lambda function runs in.

Valid values are GreengrassContainer or NoContainer . Typically, this is GreengrassContainer . For more information, see Containerization in the Developer Guide .

  • When set on the DefaultConfig property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.
  • When set on the Environment property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.

We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.

runAs?

Type: IResolvable | RunAsProperty (optional)

The user and group permissions used to run the Lambda function.

Typically, this is the ggc_user and ggc_group. For more information, see Run as in the Developer Guide .

  • When set on the DefaultConfig property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.
  • When set on the Environment property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.

Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see Running a Lambda Function as Root .

← PreviousNext →