Package io.github.cdklabs.projen.awscdk

Class LambdaFunctionOptions.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.LambdaFunctionOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaFunctionOptions>

Enclosing interface:

LambdaFunctionOptions

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

A builder for LambdaFunctionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LambdaFunctionOptions.Builder	awsSdkConnectionReuse(Boolean awsSdkConnectionReuse)	Sets the value of LambdaFunctionCommonOptions.getAwsSdkConnectionReuse()
LambdaFunctionOptions	build()	Builds the configured instance.
LambdaFunctionOptions.Builder	bundlingOptions(BundlingOptions bundlingOptions)	Sets the value of LambdaFunctionCommonOptions.getBundlingOptions()
LambdaFunctionOptions.Builder	cdkDeps(AwsCdkDeps cdkDeps)	Sets the value of LambdaFunctionOptions.getCdkDeps()
LambdaFunctionOptions.Builder	constructFile(String constructFile)	Sets the value of LambdaFunctionOptions.getConstructFile()
LambdaFunctionOptions.Builder	constructName(String constructName)	Sets the value of LambdaFunctionOptions.getConstructName()
LambdaFunctionOptions.Builder	edgeLambda(Boolean edgeLambda)	Sets the value of LambdaFunctionCommonOptions.getEdgeLambda()
LambdaFunctionOptions.Builder	entrypoint(String entrypoint)	Sets the value of LambdaFunctionOptions.getEntrypoint()
LambdaFunctionOptions.Builder	runtime(LambdaRuntime runtime)	Sets the value of LambdaFunctionCommonOptions.getRuntime()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cdkDeps

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

Sets the value of LambdaFunctionOptions.getCdkDeps()

Parameters:

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

Returns:

this

entrypoint

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

Sets the value of LambdaFunctionOptions.getEntrypoint()

Parameters:

entrypoint - A path from the project root directory to a TypeScript file which contains the AWS Lambda handler entrypoint (exports a handler function). This parameter is required. This is relative to the root directory of the project.

Returns:

this

constructFile

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

Sets the value of LambdaFunctionOptions.getConstructFile()

Parameters:

constructFile - The name of the generated TypeScript source file. This file should also be under the source tree.

Returns:

this

constructName

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

Sets the value of LambdaFunctionOptions.getConstructName()

Parameters:

constructName - The name of the generated lambda.Function subclass.

Returns:

this

awsSdkConnectionReuse

@Stability(Experimental)
public LambdaFunctionOptions.Builder awsSdkConnectionReuse(Boolean awsSdkConnectionReuse)

Sets the value of LambdaFunctionCommonOptions.getAwsSdkConnectionReuse()

Parameters:

awsSdkConnectionReuse - Whether to automatically reuse TCP connections when working with the AWS SDK for JavaScript. This sets the AWS_NODEJS_CONNECTION_REUSE_ENABLED environment variable to 1.

Not applicable when edgeLambda is set to true because environment variables are not supported in Lambda@Edge.

Returns:

this

bundlingOptions

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

Sets the value of LambdaFunctionCommonOptions.getBundlingOptions()

Parameters:

bundlingOptions - Bundling options for this AWS Lambda function. If not specified the default bundling options specified for the project Bundler instance will be used.

Returns:

this

edgeLambda

@Stability(Experimental)
public LambdaFunctionOptions.Builder edgeLambda(Boolean edgeLambda)

Sets the value of LambdaFunctionCommonOptions.getEdgeLambda()

Parameters:

edgeLambda - Whether to create a cloudfront.experimental.EdgeFunction instead of a lambda.Function.

Returns:

this

runtime

@Stability(Experimental)
public LambdaFunctionOptions.Builder runtime(LambdaRuntime runtime)

Sets the value of LambdaFunctionCommonOptions.getRuntime()

Parameters:

runtime - The node.js version to target.

Returns:

this

build

@Stability(Experimental)
public LambdaFunctionOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LambdaFunctionOptions

Throws:

NullPointerException - if any required attribute was not provided