Package software.amazon.awscdk.services.lambda

Class VersionProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.VersionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<VersionProps>

Enclosing interface:

VersionProps

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

A builder for VersionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VersionProps	build()	Builds the configured instance.
VersionProps.Builder	codeSha256(String codeSha256)	Sets the value of VersionOptions.getCodeSha256()
VersionProps.Builder	description(String description)	Sets the value of VersionOptions.getDescription()
VersionProps.Builder	lambda(IFunction lambda)	Sets the value of VersionProps.getLambda()
VersionProps.Builder	maxEventAge(Duration maxEventAge)	Sets the value of EventInvokeConfigOptions.getMaxEventAge()
VersionProps.Builder	maxExecutionEnvironments(Number maxExecutionEnvironments)	Sets the value of VersionOptions.getMaxExecutionEnvironments()
VersionProps.Builder	minExecutionEnvironments(Number minExecutionEnvironments)	Sets the value of VersionOptions.getMinExecutionEnvironments()
VersionProps.Builder	onFailure(IDestination onFailure)	Sets the value of EventInvokeConfigOptions.getOnFailure()
VersionProps.Builder	onSuccess(IDestination onSuccess)	Sets the value of EventInvokeConfigOptions.getOnSuccess()
VersionProps.Builder	provisionedConcurrentExecutions(Number provisionedConcurrentExecutions)	Sets the value of VersionOptions.getProvisionedConcurrentExecutions()
VersionProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of VersionOptions.getRemovalPolicy()
VersionProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of EventInvokeConfigOptions.getRetryAttempts()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

lambda

@Stability(Stable)
public VersionProps.Builder lambda(IFunction lambda)

Sets the value of VersionProps.getLambda()

Parameters:

lambda - Function to get the value of. This parameter is required.

Returns:

this

codeSha256

@Stability(Stable)
public VersionProps.Builder codeSha256(String codeSha256)

Sets the value of VersionOptions.getCodeSha256()

Parameters:

codeSha256 - SHA256 of the version of the Lambda source code. Specify to validate that you're deploying the right version.

Returns:

this

description

@Stability(Stable)
public VersionProps.Builder description(String description)

Sets the value of VersionOptions.getDescription()

Parameters:

description - Description of the version.

Returns:

this

maxExecutionEnvironments

@Stability(Stable)
public VersionProps.Builder maxExecutionEnvironments(Number maxExecutionEnvironments)

Sets the value of VersionOptions.getMaxExecutionEnvironments()

Parameters:

maxExecutionEnvironments - The maximum number of execution environments allowed for this version when published into a capacity provider. This setting limits the total number of execution environments that can be created to handle concurrent invocations of this specific version.

Returns:

this

minExecutionEnvironments

@Stability(Stable)
public VersionProps.Builder minExecutionEnvironments(Number minExecutionEnvironments)

Sets the value of VersionOptions.getMinExecutionEnvironments()

Parameters:

minExecutionEnvironments - The minimum number of execution environments to maintain for this version when published into a capacity provider. This setting ensures that at least this many execution environments are always available to handle function invocations for this specific version, reducing cold start latency.

Returns:

this

provisionedConcurrentExecutions

@Stability(Stable)
public VersionProps.Builder provisionedConcurrentExecutions(Number provisionedConcurrentExecutions)

Sets the value of VersionOptions.getProvisionedConcurrentExecutions()

Parameters:

provisionedConcurrentExecutions - Specifies a provisioned concurrency configuration for a function's version.

Returns:

this

removalPolicy

@Stability(Stable)
public VersionProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of VersionOptions.getRemovalPolicy()

Parameters:

removalPolicy - Whether to retain old versions of this function when a new version is created.

Returns:

this

maxEventAge

@Stability(Stable)
public VersionProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of EventInvokeConfigOptions.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours

Returns:

this

onFailure

@Stability(Stable)
public VersionProps.Builder onFailure(IDestination onFailure)

Sets the value of EventInvokeConfigOptions.getOnFailure()

Parameters:

onFailure - The destination for failed invocations.

Returns:

this

onSuccess

@Stability(Stable)
public VersionProps.Builder onSuccess(IDestination onSuccess)

Sets the value of EventInvokeConfigOptions.getOnSuccess()

Parameters:

onSuccess - The destination for successful invocations.

Returns:

this

retryAttempts

@Stability(Stable)
public VersionProps.Builder retryAttempts(Number retryAttempts)

Sets the value of EventInvokeConfigOptions.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2

Returns:

this

build

@Stability(Stable)
public VersionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of VersionProps

Throws:

NullPointerException - if any required attribute was not provided