software.amazon.awscdk.services.lambda

Class Version.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.Version.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Version>

Enclosing class:

Version

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

(experimental) A fluent builder for Version.

Method Summary

Modifier and Type	Method and Description
Version	build()
Version.Builder	codeSha256(String codeSha256) (experimental) SHA256 of the version of the Lambda source code.
static Version.Builder	create(software.constructs.Construct scope, String id)
Version.Builder	description(String description) (experimental) Description of the version.
Version.Builder	lambda(IFunction lambda) (experimental) Function to get the value of.
Version.Builder	maxEventAge(Duration maxEventAge) (experimental) The maximum age of a request that Lambda sends to a function for processing.
Version.Builder	onFailure(IDestination onFailure) (experimental) The destination for failed invocations.
Version.Builder	onSuccess(IDestination onSuccess) (experimental) The destination for successful invocations.
Version.Builder	provisionedConcurrentExecutions(Number provisionedConcurrentExecutions) (experimental) Specifies a provisioned concurrency configuration for a function's version.
Version.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) Whether to retain old versions of this function when a new version is created.
Version.Builder	retryAttempts(Number retryAttempts) (experimental) The maximum number of times to retry when the function returns an error.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Version.Builder create(software.constructs.Construct scope,
                                                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Version.Builder.

maxEventAge

@Stability(value=Experimental)
public Version.Builder maxEventAge(Duration maxEventAge)

(experimental) The maximum age of a request that Lambda sends to a function for processing.

Minimum: 60 seconds Maximum: 6 hours

Default: Duration.hours(6)

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.

Returns:

this

onFailure

@Stability(value=Experimental)
public Version.Builder onFailure(IDestination onFailure)

(experimental) The destination for failed invocations.

Default: - no destination

Parameters:

onFailure - The destination for failed invocations. This parameter is required.

Returns:

this

onSuccess

@Stability(value=Experimental)
public Version.Builder onSuccess(IDestination onSuccess)

(experimental) The destination for successful invocations.

Default: - no destination

Parameters:

onSuccess - The destination for successful invocations. This parameter is required.

Returns:

this

retryAttempts

@Stability(value=Experimental)
public Version.Builder retryAttempts(Number retryAttempts)

(experimental) The maximum number of times to retry when the function returns an error.

Minimum: 0 Maximum: 2

Default: 2

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

codeSha256

@Stability(value=Experimental)
public Version.Builder codeSha256(String codeSha256)

(experimental) SHA256 of the version of the Lambda source code.

Specify to validate that you're deploying the right version.

Default: No validation is performed

Parameters:

codeSha256 - SHA256 of the version of the Lambda source code. This parameter is required.

Returns:

this

description

@Stability(value=Experimental)
public Version.Builder description(String description)

(experimental) Description of the version.

Default: Description of the Lambda

Parameters:

description - Description of the version. This parameter is required.

Returns:

this

provisionedConcurrentExecutions

@Stability(value=Experimental)
public Version.Builder provisionedConcurrentExecutions(Number provisionedConcurrentExecutions)

(experimental) Specifies a provisioned concurrency configuration for a function's version.

Default: No provisioned concurrency

Parameters:

provisionedConcurrentExecutions - Specifies a provisioned concurrency configuration for a function's version. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Experimental)
public Version.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) Whether to retain old versions of this function when a new version is created.

Default: RemovalPolicy.DESTROY

Parameters:

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

Returns:

this

lambda

@Stability(value=Experimental)
public Version.Builder lambda(IFunction lambda)

(experimental) Function to get the value of.

Parameters:

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

Returns:

this

build

@Stability(value=Experimental)
public Version build()

Specified by:

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