aws-cdk-lib.aws_lambda.EnvironmentOptions

interface EnvironmentOptions

LanguageType name
.NETAmazon.CDK.AWS.Lambda.EnvironmentOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambda#EnvironmentOptions
Javasoftware.amazon.awscdk.services.lambda.EnvironmentOptions
Pythonaws_cdk.aws_lambda.EnvironmentOptions
TypeScript (source)aws-cdk-lib » aws_lambda » EnvironmentOptions

Environment variables options.

Example

// 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 environmentOptions: lambda.EnvironmentOptions = {
  removeInEdge: false,
};

Properties

NameTypeDescription
removeInEdge?booleanWhen used in Lambda@Edge via edgeArn() API, these environment variables will be removed.

removeInEdge?

Type: boolean (optional, default: false - using the function in Lambda@Edge will throw)

When used in Lambda@Edge via edgeArn() API, these environment variables will be removed.

If not set, an error will be thrown.

See also: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html#lambda-requirements-lambda-function-configuration