@cdklabs/generative-ai-cdk-constructs • Docs
@cdklabs/generative-ai-cdk-constructs / DockerLambdaCustomProps
DockerLambdaCustomProps
readonlyoptionaladotInstrumentation:AdotInstrumentationConfig
Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.
- No ADOT instrumentation
stable
readonlyoptionalallowAllIpv6Outbound:boolean
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.
false
stable
readonlyoptionalapplicationLogLevelV2:ApplicationLogLevel
Sets the application log level for the function.
ApplicationLogLevel.INFO
stable
readonlyoptionalarchitecture:Architecture
The system architectures compatible with this lambda function.
Architecture.X86_64
stable
readonlycode: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.
stable
readonlyoptionalcodeSigningConfig:ICodeSigningConfig
Code signing config associated with this function.
- Not Sign the Code
stable
readonlyoptionalcurrentVersionOptions:VersionOptions
Options for the lambda.Version resource automatically created by the fn.currentVersion method.
VersionOptionsstable
readonlyoptionaldeadLetterQueue:IQueue
The SQS queue to use if DLQ is enabled.
If SNS topic is desired, specify deadLetterTopic property instead.
deadLetterQueueEnabled is truestable
readonlyoptionaldeadLetterQueueEnabled:boolean
Enabled DLQ.
If deadLetterQueue is undefined,
an SQS queue with default options will be defined for your Function.
deadLetterQueue is set, which implies DLQ is enabled.stable
readonlyoptionaldeadLetterTopic:ITopic
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.
- no SNS topic
stable
readonlyoptionalenvironment:Record<string,string>
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.
- No environment variables.
stable
readonlyoptionalenvironmentEncryption:IKey
The AWS KMS key that’s used to encrypt your function’s environment variables.
- AWS Lambda creates and uses an AWS managed customer master key (CMK).
stable
readonlyoptionalephemeralStorageSize:Size
The size of the function’s /tmp directory in MiB.
512 MiB
stable
readonlyoptionalevents:IEventSource[]
Event sources for this function.
You can also add event sources using addEventSource.
- No event sources.
stable
readonlyoptionalfilesystem:FileSystem
The filesystem configuration for the lambda function.
- will not mount any filesystem
stable
readonlyoptionalinitialPolicy:PolicyStatement[]
Initial policy statements to add to the created Lambda Role.
You can call addToRolePolicy to the created lambda to add statements post creation.
- No policy statements are added to the created Lambda role.
stable
readonlyoptionalinsightsVersion:LambdaInsightsVersion
Specify the version of CloudWatch Lambda insights to use for monitoring.
- No Lambda Insights
stable
readonlyoptionalipv6AllowedForDualStack:boolean
Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Only used if ‘vpc’ is supplied.
false
stable
readonlyoptionalloggingFormat:LoggingFormat
Sets the loggingFormat for the function.
LoggingFormat.TEXT
stable
readonlyoptionallogGroup:ILogGroup
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.
/aws/lambda/${this.functionName} - default log group created by Lambda
stable
readonlyoptionallogRetention:RetentionDays
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;
logs.RetentionDays.INFINITE
stable
readonlyoptionallogRetentionRetryOptions:LogRetentionRetryOptions
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.
- Default AWS SDK retry options.
stable
readonlyoptionallogRetentionRole:IRole
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.
- A new role is created.
stable
readonlyoptionalmaxEventAge:Duration
The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours
Duration.hours(6)
stable
readonlyoptionalmemorySize:number
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.
128
stable
readonlyoptionalonFailure:IDestination
The destination for failed invocations.
- no destination
stable
readonlyoptionalonSuccess:IDestination
The destination for successful invocations.
- no destination
stable
readonlyoptionalparamsAndSecrets:ParamsAndSecretsLayerVersion
Specify the configuration of Parameters and Secrets Extension.
- No Parameters and Secrets Extension
stable
readonlyoptionalprofiling:boolean
Enable profiling.
- No profiling.
stable
readonlyoptionalprofilingGroup:IProfilingGroup
Profiling Group.
profiling is set.stable
readonlyoptionalrecursiveLoop:RecursiveLoop
Sets the Recursive Loop Protection for Lambda Function. It lets Lambda detect and terminate unintended recursive loops.
RecursiveLoop.Terminate
stable
readonlyoptionalreservedConcurrentExecutions:number
The maximum of concurrent executions you want to reserve for the function.
- No specific limit - account limit.
stable
readonlyoptionalretryAttempts:number
The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2
2
stable
readonlyoptionalruntimeManagementMode:RuntimeManagementMode
Sets the runtime management configuration for a function’s version.
Auto
stable
readonlyoptionalsnapStart:SnapStartConf
Enable SnapStart for Lambda Function. SnapStart is currently supported only for Java 11, 17 runtime
- No snapstart
stable
readonlyoptionalsystemLogLevelV2:SystemLogLevel
Sets the system log level for the function.
SystemLogLevel.INFO
stable
readonlyoptionaltimeout:Duration
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.
Duration.seconds(3)
stable