Package io.github.cdklabs.projen.awscdk

Interface LambdaFunctionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, LambdaFunctionCommonOptions

All Known Implementing Classes:

LambdaFunctionOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.947Z")
@Stability(Experimental)
public interface LambdaFunctionOptions
extends software.amazon.jsii.JsiiSerializable, LambdaFunctionCommonOptions

(experimental) Options for Function.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LambdaFunctionOptions.Builder	A builder for LambdaFunctionOptions
static class	LambdaFunctionOptions.Jsii$Proxy	An implementation for LambdaFunctionOptions

Method Summary

Modifier and Type	Method	Description
static LambdaFunctionOptions.Builder	builder()
AwsCdkDeps	getCdkDeps()	(experimental) AWS CDK dependency manager.
default String	getConstructFile()	(experimental) The name of the generated TypeScript source file.
default String	getConstructName()	(experimental) The name of the generated lambda.Function subclass.
String	getEntrypoint()	(experimental) A path from the project root directory to a TypeScript file which contains the AWS Lambda handler entrypoint (exports a handler function).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.awscdk.LambdaFunctionCommonOptions

getAwsSdkConnectionReuse, getBundlingOptions, getEdgeLambda, getRuntime

Method Detail

getCdkDeps

@Stability(Experimental)
@NotNull
AwsCdkDeps getCdkDeps()

(experimental) AWS CDK dependency manager.

getEntrypoint

@Stability(Experimental)
@NotNull
String getEntrypoint()

(experimental) A path from the project root directory to a TypeScript file which contains the AWS Lambda handler entrypoint (exports a handler function).

This is relative to the root directory of the project.

Example:

 "src/subdir/foo.lambda.ts"
 

getConstructFile

@Stability(Experimental)
@Nullable
default String getConstructFile()

(experimental) The name of the generated TypeScript source file.

This file should also be under the source tree.

Default: - The name of the entrypoint file, with the `-function.ts` suffix instead of `.lambda.ts`.

getConstructName

@Stability(Experimental)
@Nullable
default String getConstructName()

(experimental) The name of the generated lambda.Function subclass.

Default: - A pascal cased version of the name of the entrypoint file, with the extension `Function` (e.g. `ResizeImageFunction`).

builder

@Stability(Experimental)
static LambdaFunctionOptions.Builder builder()

Returns:

a LambdaFunctionOptions.Builder of LambdaFunctionOptions