Package io.github.cdklabs.projen.awscdk

Interface LambdaExtensionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, LambdaExtensionCommonOptions

All Known Implementing Classes:

LambdaExtensionOptions.Jsii$Proxy

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

(experimental) Options for creating lambda extensions.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static LambdaExtensionOptions.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.LayerVersion subclass.
String	getEntrypoint()	(experimental) A path from the project root directory to a TypeScript file which contains the AWS Lambda extension entrypoint (stand-alone script).
default String	getName()	(experimental) Name of the extension.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getBundlingOptions, getCompatibleRuntimes

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 extension entrypoint (stand-alone script).

This is relative to the root directory of the project.

Example:

 "src/subdir/foo.lambda-extension.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 `-layer-version.ts` suffix instead of `.lambda-extension.ts`.

getConstructName

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

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

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

getName

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

(experimental) Name of the extension.

Default: - Derived from the entrypoint filename.

builder

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

Returns:

a LambdaExtensionOptions.Builder of LambdaExtensionOptions