Package io.github.cdklabs.projen.awscdk

Class LambdaExtension.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.LambdaExtension.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaExtension>

Enclosing class:

LambdaExtension

@Stability(Experimental)
public static final class LambdaExtension.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaExtension>

(experimental) A fluent builder for LambdaExtension.

Method Summary

Modifier and Type	Method	Description
LambdaExtension	build()
LambdaExtension.Builder	bundlingOptions(BundlingOptions bundlingOptions)	(experimental) Bundling options for this AWS Lambda extension.
LambdaExtension.Builder	cdkDeps(AwsCdkDeps cdkDeps)	(experimental) AWS CDK dependency manager.
LambdaExtension.Builder	compatibleRuntimes(List<? extends LambdaRuntime> compatibleRuntimes)	(experimental) The extension's compatible runtimes.
LambdaExtension.Builder	constructFile(String constructFile)	(experimental) The name of the generated TypeScript source file.
LambdaExtension.Builder	constructName(String constructName)	(experimental) The name of the generated lambda.LayerVersion subclass.
static LambdaExtension.Builder	create(Project project)
LambdaExtension.Builder	entrypoint(String entrypoint)	(experimental) A path from the project root directory to a TypeScript file which contains the AWS Lambda extension entrypoint (stand-alone script).
LambdaExtension.Builder	name(String name)	(experimental) Name of the extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Experimental)
public static LambdaExtension.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of LambdaExtension.Builder.

bundlingOptions

@Stability(Experimental)
public LambdaExtension.Builder bundlingOptions(BundlingOptions bundlingOptions)

(experimental) Bundling options for this AWS Lambda extension.

If not specified the default bundling options specified for the project Bundler instance will be used.

Default: - defaults

Parameters:

bundlingOptions - Bundling options for this AWS Lambda extension. This parameter is required.

Returns:

this

compatibleRuntimes

@Stability(Experimental)
public LambdaExtension.Builder compatibleRuntimes(List<? extends LambdaRuntime> compatibleRuntimes)

(experimental) The extension's compatible runtimes.

Parameters:

compatibleRuntimes - The extension's compatible runtimes. This parameter is required.

Returns:

this

cdkDeps

@Stability(Experimental)
public LambdaExtension.Builder cdkDeps(AwsCdkDeps cdkDeps)

(experimental) AWS CDK dependency manager.

Parameters:

cdkDeps - AWS CDK dependency manager. This parameter is required.

Returns:

this

entrypoint

@Stability(Experimental)
public LambdaExtension.Builder entrypoint(String entrypoint)

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

Parameters:

entrypoint - A path from the project root directory to a TypeScript file which contains the AWS Lambda extension entrypoint (stand-alone script). This parameter is required.

Returns:

this

constructFile

@Stability(Experimental)
public LambdaExtension.Builder constructFile(String constructFile)

(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`.

Parameters:

constructFile - The name of the generated TypeScript source file. This parameter is required.

Returns:

this

constructName

@Stability(Experimental)
public LambdaExtension.Builder constructName(String constructName)

(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`).

Parameters:

constructName - The name of the generated lambda.LayerVersion subclass. This parameter is required.

Returns:

this

name

@Stability(Experimental)
public LambdaExtension.Builder name(String name)

(experimental) Name of the extension.

Default: - Derived from the entrypoint filename.

Parameters:

name - Name of the extension. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public LambdaExtension build()

Specified by:

build in interface software.amazon.jsii.Builder<LambdaExtension>

Returns:

a newly built instance of LambdaExtension.