Skip to content
v2.277.0

EnvironmentProperty Struct ​

The environment configuration for a Lambda function on the AWS IoT Greengrass core.

In an CloudFormation template, Environment is a property of the FunctionConfiguration property type.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_greengrass as greengrass } from 'aws-cdk-lib';

declare const variables: any;
const environmentProperty: greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty = {
  accessSysfs: false,
  execution: {
    isolationMode: 'isolationMode',
    runAs: {
      gid: 123,
      uid: 123,
    },
  },
  resourceAccessPolicies: [{
    resourceId: 'resourceId',

    // the properties below are optional
    permission: 'permission',
  }],
  variables: variables,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_greengrass as greengrass

# variables: Any

environment_property = greengrass.CfnFunctionDefinitionVersion.EnvironmentProperty(
    access_sysfs=False,
    execution=greengrass.CfnFunctionDefinitionVersion.ExecutionProperty(
        isolation_mode="isolationMode",
        run_as=greengrass.CfnFunctionDefinitionVersion.RunAsProperty(
            gid=123,
            uid=123
        )
    ),
    resource_access_policies=[greengrass.CfnFunctionDefinitionVersion.ResourceAccessPolicyProperty(
        resource_id="resourceId",

        # the properties below are optional
        permission="permission"
    )],
    variables=variables
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.greengrass.*;

Object variables;

EnvironmentProperty environmentProperty = EnvironmentProperty.builder()
        .accessSysfs(false)
        .execution(ExecutionProperty.builder()
                .isolationMode("isolationMode")
                .runAs(RunAsProperty.builder()
                        .gid(123)
                        .uid(123)
                        .build())
                .build())
        .resourceAccessPolicies(List.of(ResourceAccessPolicyProperty.builder()
                .resourceId("resourceId")

                // the properties below are optional
                .permission("permission")
                .build()))
        .variables(variables)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 environmentProperty = 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
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var variables interface{}

environmentProperty := &EnvironmentProperty{
	AccessSysfs: jsii.Boolean(false),
	Execution: &ExecutionProperty{
		IsolationMode: jsii.String("isolationMode"),
		RunAs: &RunAsProperty{
			Gid: jsii.Number(123),
			Uid: jsii.Number(123),
		},
	},
	ResourceAccessPolicies: []interface{}{
		&ResourceAccessPolicyProperty{
			ResourceId: jsii.String("resourceId"),

			// the properties below are optional
			Permission: jsii.String("permission"),
		},
	},
	Variables: variables,
}

Properties ​

accessSysfsoptionalboolean | IResolvableaccess_sysfsoptionaltyping.Union[bool, IResolvable]accessSysfsoptionalBooleanAccessSysfsoptionalboolAccessSysfsoptionalinterface{}#
Indicates whether the function is allowed to access the `/sys` directory on the core device, which allows the read device information from `/sys` .

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

executionoptionalIResolvable | CfnFunctionDefinitionVersion.ExecutionPropertyexecutionoptionaltyping.Union[IResolvable, ExecutionProperty]executionoptionalIResolvableExecutionoptionalIResolvableExecutionoptionalinterface{}#
Settings for the Lambda execution environment in AWS IoT Greengrass .
resourceAccessPoliciesoptionalIResolvable | IResolvable | CfnFunctionDefinitionVersion.ResourceAccessPolicyProperty[]resource_access_policiesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourceAccessPolicyProperty]]]resourceAccessPoliciesoptionalIResolvableResourceAccessPoliciesoptionalIResolvableResourceAccessPoliciesoptionalinterface{}#
A list of the resources in the group that the function can access, with the corresponding read-only or read-write permissions. The maximum is 10 resources.

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

variablesoptionalanyvariablesoptionalAnyvariablesoptionalObjectVariablesoptionalobjectVariablesoptionalinterface{}#
Environment variables for the Lambda function.