Class NodejsFunction.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<NodejsFunction>
- Enclosing class:
NodejsFunction
NodejsFunction
.-
Method Summary
Modifier and TypeMethodDescriptionadotInstrumentation
(AdotInstrumentationConfig adotInstrumentation) Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.allowAllIpv6Outbound
(Boolean allowAllIpv6Outbound) Whether to allow the Lambda to send all ipv6 network traffic.allowAllOutbound
(Boolean allowAllOutbound) Whether to allow the Lambda to send all network traffic (except ipv6).allowPublicSubnet
(Boolean allowPublicSubnet) Lambda Functions in a public subnet can NOT access the internet.applicationLogLevel
(String applicationLogLevel) Deprecated.applicationLogLevelV2
(ApplicationLogLevel applicationLogLevelV2) Sets the application log level for the function.architecture
(Architecture architecture) The system architectures compatible with this lambda function.awsSdkConnectionReuse
(Boolean awsSdkConnectionReuse) TheAWS_NODEJS_CONNECTION_REUSE_ENABLED
environment variable does not exist in the AWS SDK for JavaScript v3.build()
bundling
(BundlingOptions bundling) Bundling options.The code that will be deployed to the Lambda Handler.codeSigningConfig
(ICodeSigningConfig codeSigningConfig) Code signing config associated with this function.static NodejsFunction.Builder
currentVersionOptions
(VersionOptions currentVersionOptions) Options for thelambda.Version
resource automatically created by thefn.currentVersion
method.deadLetterQueue
(IQueue deadLetterQueue) The SQS queue to use if DLQ is enabled.deadLetterQueueEnabled
(Boolean deadLetterQueueEnabled) Enabled DLQ.deadLetterTopic
(ITopic deadLetterTopic) The SNS topic to use as a DLQ.depsLockFilePath
(String depsLockFilePath) The path to the dependencies lock file (yarn.lock
,pnpm-lock.yaml
orpackage-lock.json
).description
(String description) A description of the function.Path to the entry file (JavaScript or TypeScript).environment
(Map<String, String> environment) Key-value pairs that Lambda caches and makes available for your Lambda functions.environmentEncryption
(IKey environmentEncryption) The AWS KMS key that's used to encrypt your function's environment variables.ephemeralStorageSize
(Size ephemeralStorageSize) The size of the function’s /tmp directory in MiB.events
(List<? extends IEventSource> events) Event sources for this function.filesystem
(FileSystem filesystem) The filesystem configuration for the lambda function.functionName
(String functionName) A name for the function.The name of the exported handler in the entry file.initialPolicy
(List<? extends PolicyStatement> initialPolicy) Initial policy statements to add to the created Lambda Role.insightsVersion
(LambdaInsightsVersion insightsVersion) Specify the version of CloudWatch Lambda insights to use for monitoring.ipv6AllowedForDualStack
(Boolean ipv6AllowedForDualStack) Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.layers
(List<? extends ILayerVersion> layers) A list of layers to add to the function's execution environment.Deprecated.UseloggingFormat
as a property instead.loggingFormat
(LoggingFormat loggingFormat) Sets the loggingFormat for the function.The log group the function sends logs to.logRetention
(RetentionDays logRetention) The number of days log events are kept in CloudWatch Logs.logRetentionRetryOptions
(LogRetentionRetryOptions logRetentionRetryOptions) When log retention is specified, a custom resource attempts to create the CloudWatch log group.logRetentionRole
(IRole logRetentionRole) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.maxEventAge
(Duration maxEventAge) The maximum age of a request that Lambda sends to a function for processing.memorySize
(Number memorySize) The amount of memory, in MB, that is allocated to your Lambda function.onFailure
(IDestination onFailure) The destination for failed invocations.onSuccess
(IDestination onSuccess) The destination for successful invocations.paramsAndSecrets
(ParamsAndSecretsLayerVersion paramsAndSecrets) Specify the configuration of Parameters and Secrets Extension.Enable profiling.profilingGroup
(IProfilingGroup profilingGroup) Profiling Group.projectRoot
(String projectRoot) The path to the directory containing project config files (package.json
ortsconfig.json
).recursiveLoop
(RecursiveLoop recursiveLoop) Sets the Recursive Loop Protection for Lambda Function.reservedConcurrentExecutions
(Number reservedConcurrentExecutions) The maximum of concurrent executions you want to reserve for the function.retryAttempts
(Number retryAttempts) The maximum number of times to retry when the function returns an error.Lambda execution role.The runtime environment.runtimeManagementMode
(RuntimeManagementMode runtimeManagementMode) Sets the runtime management configuration for a function's version.securityGroups
(List<? extends ISecurityGroup> securityGroups) The list of security groups to associate with the Lambda's network interfaces.snapStart
(SnapStartConf snapStart) Enable SnapStart for Lambda Function.systemLogLevel
(String systemLogLevel) Deprecated.UsesystemLogLevelV2
as a property instead.systemLogLevelV2
(SystemLogLevel systemLogLevelV2) Sets the system log level for the function.The function execution time (in seconds) after which Lambda terminates the function.Enable AWS X-Ray Tracing for Lambda Function.VPC network to place Lambda network interfaces.vpcSubnets
(SubnetSelection vpcSubnets) Where to place the network interfaces within the VPC.
-
Method Details
-
create
@Stability(Stable) public static NodejsFunction.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
NodejsFunction.Builder
.
-
maxEventAge
The maximum age of a request that Lambda sends to a function for processing.Minimum: 60 seconds Maximum: 6 hours
Default: Duration.hours(6)
- Parameters:
maxEventAge
- The maximum age of a request that Lambda sends to a function for processing. This parameter is required.- Returns:
this
-
onFailure
The destination for failed invocations.Default: - no destination
- Parameters:
onFailure
- The destination for failed invocations. This parameter is required.- Returns:
this
-
onSuccess
The destination for successful invocations.Default: - no destination
- Parameters:
onSuccess
- The destination for successful invocations. This parameter is required.- Returns:
this
-
retryAttempts
The maximum number of times to retry when the function returns an error.Minimum: 0 Maximum: 2
Default: 2
- Parameters:
retryAttempts
- The maximum number of times to retry when the function returns an error. This parameter is required.- Returns:
this
-
adotInstrumentation
@Stability(Stable) public NodejsFunction.Builder adotInstrumentation(AdotInstrumentationConfig adotInstrumentation) Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.Default: - No ADOT instrumentation
- Parameters:
adotInstrumentation
- Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. This parameter is required.- Returns:
this
- See Also:
-
allowAllIpv6Outbound
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
orsecurityGroup
property is set. Instead, configureallowAllIpv6Outbound
directly on the security group.Default: false
- Parameters:
allowAllIpv6Outbound
- Whether to allow the Lambda to send all ipv6 network traffic. This parameter is required.- Returns:
this
-
allowAllOutbound
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
orsecurityGroup
property is set. Instead, configureallowAllOutbound
directly on the security group.Default: true
- Parameters:
allowAllOutbound
- Whether to allow the Lambda to send all network traffic (except ipv6). This parameter is required.- Returns:
this
-
allowPublicSubnet
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.
Default: false
- Parameters:
allowPublicSubnet
- Lambda Functions in a public subnet can NOT access the internet. This parameter is required.- Returns:
this
- See Also:
-
applicationLogLevel
@Stability(Deprecated) @Deprecated public NodejsFunction.Builder applicationLogLevel(String applicationLogLevel) Deprecated.UseapplicationLogLevelV2
as a property instead.(deprecated) Sets the application log level for the function.Default: "INFO"
- Parameters:
applicationLogLevel
- Sets the application log level for the function. This parameter is required.- Returns:
this
-
applicationLogLevelV2
@Stability(Stable) public NodejsFunction.Builder applicationLogLevelV2(ApplicationLogLevel applicationLogLevelV2) Sets the application log level for the function.Default: ApplicationLogLevel.INFO
- Parameters:
applicationLogLevelV2
- Sets the application log level for the function. This parameter is required.- Returns:
this
-
architecture
The system architectures compatible with this lambda function.Default: Architecture.X86_64
- Parameters:
architecture
- The system architectures compatible with this lambda function. This parameter is required.- Returns:
this
-
codeSigningConfig
@Stability(Stable) public NodejsFunction.Builder codeSigningConfig(ICodeSigningConfig codeSigningConfig) Code signing config associated with this function.Default: - Not Sign the Code
- Parameters:
codeSigningConfig
- Code signing config associated with this function. This parameter is required.- Returns:
this
-
currentVersionOptions
@Stability(Stable) public NodejsFunction.Builder currentVersionOptions(VersionOptions currentVersionOptions) Options for thelambda.Version
resource automatically created by thefn.currentVersion
method.Default: - default options as described in `VersionOptions`
- Parameters:
currentVersionOptions
- Options for thelambda.Version
resource automatically created by thefn.currentVersion
method. This parameter is required.- Returns:
this
-
deadLetterQueue
The SQS queue to use if DLQ is enabled.If SNS topic is desired, specify
deadLetterTopic
property instead.Default: - SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true`
- Parameters:
deadLetterQueue
- The SQS queue to use if DLQ is enabled. This parameter is required.- Returns:
this
-
deadLetterQueueEnabled
@Stability(Stable) public NodejsFunction.Builder deadLetterQueueEnabled(Boolean deadLetterQueueEnabled) Enabled DLQ.If
deadLetterQueue
is undefined, an SQS queue with default options will be defined for your Function.Default: - false unless `deadLetterQueue` is set, which implies DLQ is enabled.
- Parameters:
deadLetterQueueEnabled
- Enabled DLQ. This parameter is required.- Returns:
this
-
deadLetterTopic
The SNS topic to use as a DLQ.Note that if
deadLetterQueueEnabled
is set totrue
, 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.Default: - no SNS topic
- Parameters:
deadLetterTopic
- The SNS topic to use as a DLQ. This parameter is required.- Returns:
this
-
description
A description of the function.Default: - No description.
- Parameters:
description
- A description of the function. This parameter is required.- Returns:
this
-
environment
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.
Default: - No environment variables.
- Parameters:
environment
- Key-value pairs that Lambda caches and makes available for your Lambda functions. This parameter is required.- Returns:
this
-
environmentEncryption
The AWS KMS key that's used to encrypt your function's environment variables.Default: - AWS Lambda creates and uses an AWS managed customer master key (CMK).
- Parameters:
environmentEncryption
- The AWS KMS key that's used to encrypt your function's environment variables. This parameter is required.- Returns:
this
-
ephemeralStorageSize
The size of the function’s /tmp directory in MiB.Default: 512 MiB
- Parameters:
ephemeralStorageSize
- The size of the function’s /tmp directory in MiB. This parameter is required.- Returns:
this
-
events
Event sources for this function.You can also add event sources using
addEventSource
.Default: - No event sources.
- Parameters:
events
- Event sources for this function. This parameter is required.- Returns:
this
-
filesystem
The filesystem configuration for the lambda function.Default: - will not mount any filesystem
- Parameters:
filesystem
- The filesystem configuration for the lambda function. This parameter is required.- Returns:
this
-
functionName
A name for the function.Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.
- Parameters:
functionName
- A name for the function. This parameter is required.- Returns:
this
-
initialPolicy
@Stability(Stable) public NodejsFunction.Builder initialPolicy(List<? extends PolicyStatement> initialPolicy) Initial policy statements to add to the created Lambda Role.You can call
addToRolePolicy
to the created lambda to add statements post creation.Default: - No policy statements are added to the created Lambda role.
- Parameters:
initialPolicy
- Initial policy statements to add to the created Lambda Role. This parameter is required.- Returns:
this
-
insightsVersion
@Stability(Stable) public NodejsFunction.Builder insightsVersion(LambdaInsightsVersion insightsVersion) Specify the version of CloudWatch Lambda insights to use for monitoring.Default: - No Lambda Insights
- Parameters:
insightsVersion
- Specify the version of CloudWatch Lambda insights to use for monitoring. This parameter is required.- Returns:
this
- See Also:
-
ipv6AllowedForDualStack
@Stability(Stable) public NodejsFunction.Builder ipv6AllowedForDualStack(Boolean ipv6AllowedForDualStack) Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.Only used if 'vpc' is supplied.
Default: false
- Parameters:
ipv6AllowedForDualStack
- Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. This parameter is required.- Returns:
this
-
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.
Default: - No layers.
- Parameters:
layers
- A list of layers to add to the function's execution environment. This parameter is required.- Returns:
this
-
logFormat
Deprecated.UseloggingFormat
as a property instead.(deprecated) Sets the logFormat for the function.Default: "Text"
- Parameters:
logFormat
- Sets the logFormat for the function. This parameter is required.- Returns:
this
-
loggingFormat
Sets the loggingFormat for the function.Default: LoggingFormat.TEXT
- Parameters:
loggingFormat
- Sets the loggingFormat for the function. This parameter is required.- Returns:
this
-
logGroup
The log group the function sends logs to.By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/
. 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.
Default: `/aws/lambda/${this.functionName}` - default log group created by Lambda
- Parameters:
logGroup
- The log group the function sends logs to. This parameter is required.- Returns:
this
-
logRetention
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 thelogGroup
property to instruct the Lambda function to send logs to it. Migrating fromlogRetention
tologGroup
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 software.amazon.awscdk.services.logs.*; LogGroup myLogGroup; myLogGroup.getLogGroupName();
Default: logs.RetentionDays.INFINITE
- Parameters:
logRetention
- The number of days log events are kept in CloudWatch Logs. This parameter is required.- Returns:
this
-
logRetentionRetryOptions
@Stability(Stable) public NodejsFunction.Builder logRetentionRetryOptions(LogRetentionRetryOptions 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: - Default AWS SDK retry options.
- Parameters:
logRetentionRetryOptions
- When log retention is specified, a custom resource attempts to create the CloudWatch log group. This parameter is required.- Returns:
this
-
logRetentionRole
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.Default: - A new role is created.
- Parameters:
logRetentionRole
- The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This parameter is required.- Returns:
this
-
memorySize
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.
Default: 128
- Parameters:
memorySize
- The amount of memory, in MB, that is allocated to your Lambda function. This parameter is required.- Returns:
this
-
paramsAndSecrets
@Stability(Stable) public NodejsFunction.Builder paramsAndSecrets(ParamsAndSecretsLayerVersion paramsAndSecrets) Specify the configuration of Parameters and Secrets Extension.Default: - No Parameters and Secrets Extension
- Parameters:
paramsAndSecrets
- Specify the configuration of Parameters and Secrets Extension. This parameter is required.- Returns:
this
- See Also:
-
profiling
Enable profiling.Default: - No profiling.
- Parameters:
profiling
- Enable profiling. This parameter is required.- Returns:
this
- See Also:
-
profilingGroup
Profiling Group.Default: - A new profiling group will be created if `profiling` is set.
- Parameters:
profilingGroup
- Profiling Group. This parameter is required.- Returns:
this
- See Also:
-
recursiveLoop
Sets the Recursive Loop Protection for Lambda Function.It lets Lambda detect and terminate unintended recusrive loops.
Default: RecursiveLoop.Terminate
- Parameters:
recursiveLoop
- Sets the Recursive Loop Protection for Lambda Function. This parameter is required.- Returns:
this
-
reservedConcurrentExecutions
@Stability(Stable) public NodejsFunction.Builder reservedConcurrentExecutions(Number reservedConcurrentExecutions) The maximum of concurrent executions you want to reserve for the function.Default: - No specific limit - account limit.
- Parameters:
reservedConcurrentExecutions
- The maximum of concurrent executions you want to reserve for the function. This parameter is required.- Returns:
this
- See Also:
-
role
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".
Default: - A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling `addToRolePolicy`.
- Parameters:
role
- Lambda execution role. This parameter is required.- Returns:
this
-
runtimeManagementMode
@Stability(Stable) public NodejsFunction.Builder runtimeManagementMode(RuntimeManagementMode runtimeManagementMode) Sets the runtime management configuration for a function's version.Default: Auto
- Parameters:
runtimeManagementMode
- Sets the runtime management configuration for a function's version. This parameter is required.- Returns:
this
-
securityGroups
@Stability(Stable) public NodejsFunction.Builder securityGroups(List<? extends ISecurityGroup> securityGroups) The list of security groups to associate with the Lambda's network interfaces.Only used if 'vpc' is supplied.
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.
- Parameters:
securityGroups
- The list of security groups to associate with the Lambda's network interfaces. This parameter is required.- Returns:
this
-
snapStart
Enable SnapStart for Lambda Function.SnapStart is currently supported only for Java 11, 17 runtime
Default: - No snapstart
- Parameters:
snapStart
- Enable SnapStart for Lambda Function. This parameter is required.- Returns:
this
-
systemLogLevel
@Stability(Deprecated) @Deprecated public NodejsFunction.Builder systemLogLevel(String systemLogLevel) Deprecated.UsesystemLogLevelV2
as a property instead.(deprecated) Sets the system log level for the function.Default: "INFO"
- Parameters:
systemLogLevel
- Sets the system log level for the function. This parameter is required.- Returns:
this
-
systemLogLevelV2
Sets the system log level for the function.Default: SystemLogLevel.INFO
- Parameters:
systemLogLevelV2
- Sets the system log level for the function. This parameter is required.- Returns:
this
-
timeout
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.
Default: Duration.seconds(3)
- Parameters:
timeout
- The function execution time (in seconds) after which Lambda terminates the function. This parameter is required.- Returns:
this
-
tracing
Enable AWS X-Ray Tracing for Lambda Function.Default: Tracing.Disabled
- Parameters:
tracing
- Enable AWS X-Ray Tracing for Lambda Function. This parameter is required.- Returns:
this
-
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.Default: - Function is not placed within a VPC.
- Parameters:
vpc
- VPC network to place Lambda network interfaces. This parameter is required.- Returns:
this
-
vpcSubnets
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. Ifvpc
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 totrue
).Default: - the Vpc default strategy if not specified
- Parameters:
vpcSubnets
- Where to place the network interfaces within the VPC. This parameter is required.- Returns:
this
-
awsSdkConnectionReuse
@Stability(Stable) public NodejsFunction.Builder awsSdkConnectionReuse(Boolean awsSdkConnectionReuse) TheAWS_NODEJS_CONNECTION_REUSE_ENABLED
environment variable does not exist in the AWS SDK for JavaScript v3.This prop will be deprecated when the Lambda Node16 runtime is deprecated on June 12, 2024. See https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy
Info for Node 16 runtimes / SDK v2 users:
Whether to automatically reuse TCP connections when working with the AWS SDK for JavaScript v2.
This sets the
AWS_NODEJS_CONNECTION_REUSE_ENABLED
environment variable to1
.Default: - false (obsolete) for runtimes >= Node 18, true for runtimes invalid input: '<'= Node 16.
- Parameters:
awsSdkConnectionReuse
- TheAWS_NODEJS_CONNECTION_REUSE_ENABLED
environment variable does not exist in the AWS SDK for JavaScript v3. This parameter is required.- Returns:
this
- See Also:
-
bundling
Bundling options.Default: - use default bundling options: no minify, no sourcemap, all modules are bundled.
- Parameters:
bundling
- Bundling options. This parameter is required.- Returns:
this
-
code
The code that will be deployed to the Lambda Handler.If included, then properties related to bundling of the code are ignored.
- If the
code
field is specified, then you must include thehandler
property.
Default: - the code is bundled by esbuild
- Parameters:
code
- The code that will be deployed to the Lambda Handler. This parameter is required.- Returns:
this
- If the
-
depsLockFilePath
The path to the dependencies lock file (yarn.lock
,pnpm-lock.yaml
orpackage-lock.json
).This will be used as the source for the volume mounted in the Docker container.
Modules specified in
nodeModules
will be installed using the right installer (yarn
,pnpm
ornpm
) along with this lock file.Default: - the path is found by walking up parent directories searching for a `yarn.lock`, `pnpm-lock.yaml` or `package-lock.json` file
- Parameters:
depsLockFilePath
- The path to the dependencies lock file (yarn.lock
,pnpm-lock.yaml
orpackage-lock.json
). This parameter is required.- Returns:
this
-
entry
Path to the entry file (JavaScript or TypeScript).Default: - Derived from the name of the defining file and the construct's id. If the `NodejsFunction` is defined in `stack.ts` with `my-handler` as id (`new NodejsFunction(this, 'my-handler')`), the construct will look at `stack.my-handler.ts` and `stack.my-handler.js`.
- Parameters:
entry
- Path to the entry file (JavaScript or TypeScript). This parameter is required.- Returns:
this
-
handler
The name of the exported handler in the entry file.- If the
code
property is supplied, then you must include thehandler
property. The handler should be the name of the file that contains the exported handler and the function that should be called when the AWS Lambda is invoked. For example, if you had a file calledmyLambda.js
and the function to be invoked wasmyHandler
, then you should inputhandler
property asmyLambda.myHandler
. - If the
code
property is not supplied and the handler input does not contain a.
, then the handler is prefixed withindex.
(index period). Otherwise, the handler property is not modified.
Default: handler
- Parameters:
handler
- The name of the exported handler in the entry file. This parameter is required.- Returns:
this
- If the
-
projectRoot
The path to the directory containing project config files (package.json
ortsconfig.json
).Default: - the directory containing the `depsLockFilePath`
- Parameters:
projectRoot
- The path to the directory containing project config files (package.json
ortsconfig.json
). This parameter is required.- Returns:
this
-
runtime
The runtime environment.Only runtimes of the Node.js family are supported.
Default: `Runtime.NODEJS_LATEST` if the `@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion` feature flag is enabled, otherwise `Runtime.NODEJS_16_X`
- Parameters:
runtime
- The runtime environment. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<NodejsFunction>
- Returns:
- a newly built instance of
NodejsFunction
.
-
applicationLogLevelV2
as a property instead.