interface FunctionOptions

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.FunctionOptions
Java	software.amazon.awscdk.services.lambda.FunctionOptions
Python	aws_cdk.aws_lambda.FunctionOptions
TypeScript (source)	@aws-cdk/aws-lambda » FunctionOptions

Non runtime options.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codeguruprofiler from '@aws-cdk/aws-codeguruprofiler';
import * as ec2 from '@aws-cdk/aws-ec2';
import * as iam from '@aws-cdk/aws-iam';
import * as kms from '@aws-cdk/aws-kms';
import * as lambda from '@aws-cdk/aws-lambda';
import * as logs from '@aws-cdk/aws-logs';
import * as sns from '@aws-cdk/aws-sns';
import * as sqs from '@aws-cdk/aws-sqs';
import * as cdk from '@aws-cdk/core';

declare const architecture: lambda.Architecture;
declare const codeSigningConfig: lambda.CodeSigningConfig;
declare const destination: lambda.IDestination;
declare const eventSource: lambda.IEventSource;
declare const fileSystem: lambda.FileSystem;
declare const key: kms.Key;
declare const lambdaInsightsVersion: lambda.LambdaInsightsVersion;
declare const layerVersion: lambda.LayerVersion;
declare const policyStatement: iam.PolicyStatement;
declare const profilingGroup: codeguruprofiler.ProfilingGroup;
declare const queue: sqs.Queue;
declare const role: iam.Role;
declare const securityGroup: ec2.SecurityGroup;
declare const size: cdk.Size;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const topic: sns.Topic;
declare const vpc: ec2.Vpc;
const functionOptions: lambda.FunctionOptions = {
  allowAllOutbound: false,
  allowPublicSubnet: false,
  architecture: architecture,
  architectures: [architecture],
  codeSigningConfig: codeSigningConfig,
  currentVersionOptions: {
    codeSha256: 'codeSha256',
    description: 'description',
    maxEventAge: cdk.Duration.minutes(30),
    onFailure: destination,
    onSuccess: destination,
    provisionedConcurrentExecutions: 123,
    removalPolicy: cdk.RemovalPolicy.DESTROY,
    retryAttempts: 123,
  },
  deadLetterQueue: queue,
  deadLetterQueueEnabled: false,
  deadLetterTopic: topic,
  description: 'description',
  environment: {
    environmentKey: 'environment',
  },
  environmentEncryption: key,
  ephemeralStorageSize: size,
  events: [eventSource],
  filesystem: fileSystem,
  functionName: 'functionName',
  initialPolicy: [policyStatement],
  insightsVersion: lambdaInsightsVersion,
  layers: [layerVersion],
  logRetention: logs.RetentionDays.ONE_DAY,
  logRetentionRetryOptions: {
    base: cdk.Duration.minutes(30),
    maxRetries: 123,
  },
  logRetentionRole: role,
  maxEventAge: cdk.Duration.minutes(30),
  memorySize: 123,
  onFailure: destination,
  onSuccess: destination,
  profiling: false,
  profilingGroup: profilingGroup,
  reservedConcurrentExecutions: 123,
  retryAttempts: 123,
  role: role,
  securityGroup: securityGroup,
  securityGroups: [securityGroup],
  timeout: cdk.Duration.minutes(30),
  tracing: lambda.Tracing.ACTIVE,
  vpc: vpc,
  vpcSubnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnetName: 'subnetName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.ISOLATED,
  },
};

Properties

Name	Type	Description
allowAllOutbound?	boolean	Whether to allow the Lambda to send all network traffic.
allowPublicSubnet?	boolean	Lambda Functions in a public subnet can NOT access the internet.
architecture?	Architecture	The system architectures compatible with this lambda function.
architectures?⚠️	Architecture[]	DEPRECATED.
codeSigningConfig?	ICodeSigningConfig	Code signing config associated with this function.
currentVersionOptions?	VersionOptions	Options for the lambda.Version resource automatically created by the fn.currentVersion method.
deadLetterQueue?	IQueue	The SQS queue to use if DLQ is enabled.
deadLetterQueueEnabled?	boolean	Enabled DLQ.
deadLetterTopic?	ITopic	The SNS topic to use as a DLQ.
description?	string	A description of the function.
environment?	{ [string]: string }	Key-value pairs that Lambda caches and makes available for your Lambda functions.
environmentEncryption?	IKey	The AWS KMS key that's used to encrypt your function's environment variables.
ephemeralStorageSize?	Size	The size of the function’s /tmp directory in MiB.
events?	IEventSource[]	Event sources for this function.
filesystem?	FileSystem	The filesystem configuration for the lambda function.
functionName?	string	A name for the function.
initialPolicy?	PolicyStatement[]	Initial policy statements to add to the created Lambda Role.
insightsVersion?	LambdaInsightsVersion	Specify the version of CloudWatch Lambda insights to use for monitoring.
layers?	ILayerVersion[]	A list of layers to add to the function's execution environment.
logRetention?	RetentionDays	The number of days log events are kept in CloudWatch Logs.
logRetentionRetryOptions?	LogRetentionRetryOptions	When log retention is specified, a custom resource attempts to create the CloudWatch log group.
logRetentionRole?	IRole	The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
maxEventAge?	Duration	The maximum age of a request that Lambda sends to a function for processing.
memorySize?	number	The amount of memory, in MB, that is allocated to your Lambda function.
onFailure?	IDestination	The destination for failed invocations.
onSuccess?	IDestination	The destination for successful invocations.
profiling?	boolean	Enable profiling.
profilingGroup?	IProfilingGroup	Profiling Group.
reservedConcurrentExecutions?	number	The maximum of concurrent executions you want to reserve for the function.
retryAttempts?	number	The maximum number of times to retry when the function returns an error.
role?	IRole	Lambda execution role.
securityGroup?⚠️	ISecurityGroup	What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead.
securityGroups?	ISecurityGroup[]	The list of security groups to associate with the Lambda's network interfaces.
timeout?	Duration	The function execution time (in seconds) after which Lambda terminates the function.
tracing?	Tracing	Enable AWS X-Ray Tracing for Lambda Function.
vpc?	IVpc	VPC network to place Lambda network interfaces.
vpcSubnets?	SubnetSelection	Where to place the network interfaces within the VPC.

---

allowAllOutbound?

Type: boolean (optional, default: true)

Whether to allow the Lambda to send all network traffic.

If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.

---

allowPublicSubnet?

Type: boolean (optional, default: false)

Lambda Functions in a public subnet can NOT access the internet.

Use this property to acknowledge this limitation and still place the function in a public subnet.

See also: https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841

---

architecture?

Type: Architecture (optional, default: Architecture.X86_64)

The system architectures compatible with this lambda function.

---

architectures?⚠️

⚠️ Deprecated: use architecture

Type: Architecture[] (optional, default: [Architecture.X86_64])

DEPRECATED.

---

codeSigningConfig?

Type: ICodeSigningConfig (optional, default: Not Sign the Code)

Code signing config associated with this function.

---

currentVersionOptions?

Type: VersionOptions (optional, default: default options as described in VersionOptions)

Options for the lambda.Version resource automatically created by the fn.currentVersion method.

---

deadLetterQueue?

Type: IQueue (optional, default: SQS queue with 14 day retention period if deadLetterQueueEnabled is true)

The SQS queue to use if DLQ is enabled.

If SNS topic is desired, specify deadLetterTopic property instead.

---

deadLetterQueueEnabled?

Type: boolean (optional, default: false unless deadLetterQueue is set, which implies DLQ is enabled.)

Enabled DLQ.

If deadLetterQueue is undefined, an SQS queue with default options will be defined for your Function.

---

deadLetterTopic?

Type: ITopic (optional, default: no SNS topic)

The SNS topic to use as a DLQ.

Note that if deadLetterQueueEnabled is set to true, an SQS queue will be created rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.

---

description?

Type: string (optional, default: No description.)

A description of the function.

---

environment?

Type: { [string]: string } (optional, default: No environment variables.)

Key-value pairs that Lambda caches and makes available for your Lambda functions.

Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

---

environmentEncryption?

Type: IKey (optional, default: AWS Lambda creates and uses an AWS managed customer master key (CMK).)

The AWS KMS key that's used to encrypt your function's environment variables.

---

ephemeralStorageSize?

Type: Size (optional, default: 512 MiB)

The size of the function’s /tmp directory in MiB.

---

events?

Type: IEventSource[] (optional, default: No event sources.)

Event sources for this function.

You can also add event sources using addEventSource.

---

filesystem?

Type: FileSystem (optional, default: will not mount any filesystem)

The filesystem configuration for the lambda function.

---

functionName?

Type: string (optional, default: AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.)

A name for the function.

---

initialPolicy?

Type: PolicyStatement[] (optional, default: No policy statements are added to the created Lambda role.)

Initial policy statements to add to the created Lambda Role.

You can call addToRolePolicy to the created lambda to add statements post creation.

---

insightsVersion?

Type: LambdaInsightsVersion (optional, default: No Lambda Insights)

Specify the version of CloudWatch Lambda insights to use for monitoring.

See also: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html

---

layers?

Type: ILayerVersion[] (optional, default: No layers.)

A list of layers to add to the function's execution environment.

You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions.

---

logRetention?

Type: RetentionDays (optional, default: logs.RetentionDays.INFINITE)

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE.

---

logRetentionRetryOptions?

Type: LogRetentionRetryOptions (optional, default: Default AWS SDK retry options.)

When log retention is specified, a custom resource attempts to create the CloudWatch log group.

These options control the retry policy when interacting with CloudWatch APIs.

---

logRetentionRole?

Type: IRole (optional, default: A new role is created.)

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

---

maxEventAge?

Type: Duration (optional, default: Duration.hours(6))

The maximum age of a request that Lambda sends to a function for processing.

Minimum: 60 seconds Maximum: 6 hours

---

memorySize?

Type: number (optional, default: 128)

The amount of memory, in MB, that is allocated to your Lambda function.

Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.

---

onFailure?

Type: IDestination (optional, default: no destination)

The destination for failed invocations.

---

onSuccess?

Type: IDestination (optional, default: no destination)

The destination for successful invocations.

---

profiling?

Type: boolean (optional, default: No profiling.)

Enable profiling.

See also: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html

---

profilingGroup?

Type: IProfilingGroup (optional, default: A new profiling group will be created if profiling is set.)

Profiling Group.

See also: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html

---

reservedConcurrentExecutions?

Type: number (optional, default: No specific limit - account limit.)

The maximum of concurrent executions you want to reserve for the function.

See also: https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

---

retryAttempts?

Type: number (optional, default: 2)

The maximum number of times to retry when the function returns an error.

Minimum: 0 Maximum: 2

---

role?

Type: IRole (optional, default: A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling addToRolePolicy.)

Lambda execution role.

This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal.

The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself.

The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole".

---

securityGroup?⚠️

⚠️ Deprecated: - This property is deprecated, use securityGroups instead

Type: ISecurityGroup (optional, default: If the function is placed within a VPC and a security group is not specified, either by this or securityGroups prop, a dedicated security group will be created for this function.)

What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead.

Only used if 'vpc' is supplied.

Use securityGroups property instead. Function constructor will throw an error if both are specified.

---

securityGroups?

Type: ISecurityGroup[] (optional, default: If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function.)

The list of security groups to associate with the Lambda's network interfaces.

Only used if 'vpc' is supplied.

---

timeout?

Type: Duration (optional, default: Duration.seconds(3))

The function execution time (in seconds) after which Lambda terminates the function.

Because the execution time affects cost, set this value based on the function's expected execution time.

---

tracing?

Type: Tracing (optional, default: Tracing.Disabled)

Enable AWS X-Ray Tracing for Lambda Function.

---

vpc?

Type: IVpc (optional, default: Function is not placed within a VPC.)

VPC network to place Lambda network interfaces.

Specify this if the Lambda function needs to access resources in a VPC.

---

vpcSubnets?

Type: SubnetSelection (optional, default: the Vpc default strategy if not specified)

Where to place the network interfaces within the VPC.

Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.