Skip to content
v2.277.0

EnvironmentProperty Struct ​

A function's environment variable settings.

You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const environmentProperty: lambda.CfnFunction.EnvironmentProperty = {
  variables: {
    variablesKey: '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_lambda as lambda_

environment_property = lambda.CfnFunction.EnvironmentProperty(
    variables={
        "variables_key": "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.lambda.*;

EnvironmentProperty environmentProperty = EnvironmentProperty.builder()
        .variables(Map.of(
                "variablesKey", "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.Lambda;

var environmentProperty = new EnvironmentProperty {
    Variables = new Dictionary<string, string> {
        { "variablesKey", "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"

environmentProperty := &EnvironmentProperty{
	Variables: map[string]*string{
		"variablesKey": jsii.String("variables"),
	},
}

Properties ​

variablesoptionalIResolvable | { [key: string]: string }variablesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]variablesoptionalIResolvableVariablesoptionalIResolvableVariablesoptionalinterface{} #
Environment variable key-value pairs. For more information, see Using Lambda environment variables .

If the value of the environment variable is a time or a duration, enclose the value in quotes.