interface DockerImageFunctionProps

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.DockerImageFunctionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambda#DockerImageFunctionProps
Java	software.amazon.awscdk.services.lambda.DockerImageFunctionProps
Python	aws_cdk.aws_lambda.DockerImageFunctionProps
TypeScript (source)	aws-cdk-lib » aws_lambda » DockerImageFunctionProps

Properties to configure a new DockerImageFunction construct.

Example

new lambda.DockerImageFunction(this, 'AssetFunction', {
  code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, 'docker-handler')),
});

Properties

Name	Type	Description
code	DockerImageCode	The source code of your Lambda function.
adotInstrumentation?	AdotInstrumentationConfig	Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.
allowAllIpv6Outbound?	boolean	Whether to allow the Lambda to send all ipv6 network traffic.
allowAllOutbound?	boolean	Whether to allow the Lambda to send all network traffic (except ipv6).
allowPublicSubnet?	boolean	Lambda Functions in a public subnet can NOT access the internet.
applicationLogLevel?⚠️	string	Sets the application log level for the function.
applicationLogLevelV2?	ApplicationLogLevel	Sets the application log level for the function.
architecture?	Architecture	The system architectures compatible with this lambda function.
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.
ipv6AllowedForDualStack?	boolean	Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
layers?	ILayerVersion[]	A list of layers to add to the function's execution environment.
logFormat?⚠️	string	Sets the logFormat for the function.
logGroup?	ILogGroup	The log group the function sends logs to.
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.
loggingFormat?	LoggingFormat	Sets the loggingFormat for the function.
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.
paramsAndSecrets?	ParamsAndSecretsLayerVersion	Specify the configuration of Parameters and Secrets Extension.
profiling?	boolean	Enable profiling.
profilingGroup?	IProfilingGroup	Profiling Group.
recursiveLoop?	RecursiveLoop	Sets the Recursive Loop Protection for Lambda Function.
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.
runtimeManagementMode?	RuntimeManagementMode	Sets the runtime management configuration for a function's version.
securityGroups?	ISecurityGroup[]	The list of security groups to associate with the Lambda's network interfaces.
snapStart?	SnapStartConf	Enable SnapStart for Lambda Function.
systemLogLevel?⚠️	string	Sets the system log level for the function.
systemLogLevelV2?	SystemLogLevel	Sets the system log level for the function.
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.

---

code

Type: DockerImageCode

The source code of your Lambda function.

You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.

---

adotInstrumentation?

Type: AdotInstrumentationConfig (optional, default: No ADOT instrumentation)

Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.

See also: https://aws-otel.github.io/docs/getting-started/lambda

---

allowAllIpv6Outbound?

Type: boolean (optional, default: false)

Whether to allow the Lambda to send all ipv6 network traffic.

If set to true, there will only be a single egress rule which allows all outbound ipv6 traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets using ipv6.

Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllIpv6Outbound directly on the security group.

---

allowAllOutbound?

Type: boolean (optional, default: true)

Whether to allow the Lambda to send all network traffic (except ipv6).

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

Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllOutbound directly on the security group.

---

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

---

applicationLogLevel?⚠️

⚠️ Deprecated: Use applicationLogLevelV2 as a property instead.

Type: string (optional, default: "INFO")

Sets the application log level for the function.

---

applicationLogLevelV2?

Type: ApplicationLogLevel (optional, default: ApplicationLogLevel.INFO)

Sets the application log level for the function.

---

architecture?

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

The system architectures compatible with this lambda function.

---

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

---

ipv6AllowedForDualStack?

Type: boolean (optional, default: false)

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

Only used if 'vpc' is supplied.

---

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.

---

logFormat?⚠️

⚠️ Deprecated: Use loggingFormat as a property instead.

Type: string (optional, default: "Text")

Sets the logFormat for the function.

---

logGroup?

Type: ILogGroup (optional, default: /aws/lambda/${this.functionName} - default log group created by Lambda)

The log group the function sends logs to.

By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/<function name>. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention.

Use the logGroup property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it.

Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first.

---

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.

This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with logs.LogGroup and use the logGroup property to instruct the Lambda function to send logs to it. Migrating from logRetention to logGroup will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust.

In AWS CDK code, you can access the log group name directly from the LogGroup construct:

import * as logs from 'aws-cdk-lib/aws-logs';

declare const myLogGroup: logs.LogGroup;
myLogGroup.logGroupName;

---

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.

This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

---

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.

This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

---

loggingFormat?

Type: LoggingFormat (optional, default: LoggingFormat.TEXT)

Sets the loggingFormat for the function.

---

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.

---

paramsAndSecrets?

Type: ParamsAndSecretsLayerVersion (optional, default: No Parameters and Secrets Extension)

Specify the configuration of Parameters and Secrets Extension.

See also: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-integration-lambda-extensions.html

---

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

---

recursiveLoop?

Type: RecursiveLoop (optional, default: RecursiveLoop.Terminate)

Sets the Recursive Loop Protection for Lambda Function.

It lets Lambda detect and terminate unintended recursive loops.

---

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".

---

runtimeManagementMode?

Type: RuntimeManagementMode (optional, default: Auto)

Sets the runtime management configuration for a function's version.

---

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.

---

snapStart?

Type: SnapStartConf (optional, default: No snapstart)

Enable SnapStart for Lambda Function.

SnapStart is currently supported for Java 11, Java 17, Python 3.12, Python 3.13, and .NET 8 runtime

---

systemLogLevel?⚠️

⚠️ Deprecated: Use systemLogLevelV2 as a property instead.

Type: string (optional, default: "INFO")

Sets the system log level for the function.

---

systemLogLevelV2?

Type: SystemLogLevel (optional, default: SystemLogLevel.INFO)

Sets the system log level for the function.

---

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. This is required when vpcSubnets is specified.

---

vpcSubnets?

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

Where to place the network interfaces within the VPC.

This requires vpc to be specified in order for interfaces to actually be placed in the subnets. If vpc is not specify, this will raise an error.

Note: Internet access for Lambda Functions requires a NAT Gateway, so picking public subnets is not allowed (unless allowPublicSubnet is set to true).