software.amazon.awscdk.services.lambda

Interface VersionOptions

All Superinterfaces:

EventInvokeConfigOptions

All Known Subinterfaces:

VersionProps

All Known Implementing Classes:

VersionOptions.Jsii$Proxy, VersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:54.641Z")
public interface VersionOptions
extends EventInvokeConfigOptions

Options for `lambda.Version`.

Example:

 Function fn = Function.Builder.create(this, "MyFunction")
         .currentVersionOptions(VersionOptions.builder()
                 .removalPolicy(RemovalPolicy.RETAIN) // retain old versions
                 .retryAttempts(1)
                 .build())
         .runtime(Runtime.NODEJS_16_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .build();
 fn.addAlias("live");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static VersionOptions.Builder	builder()
default java.lang.String	getCodeSha256() SHA256 of the version of the Lambda source code.
default java.lang.String	getDescription() Description of the version.
default java.lang.Number	getProvisionedConcurrentExecutions() Specifies a provisioned concurrency configuration for a function's version.
default RemovalPolicy	getRemovalPolicy() Whether to retain old versions of this function when a new version is created.

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Method Detail

getCodeSha256

default java.lang.String getCodeSha256()

SHA256 of the version of the Lambda source code.

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

Default: No validation is performed

getDescription

default java.lang.String getDescription()

Description of the version.

Default: Description of the Lambda

getProvisionedConcurrentExecutions

default java.lang.Number getProvisionedConcurrentExecutions()

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

Default: No provisioned concurrency

getRemovalPolicy

default RemovalPolicy getRemovalPolicy()

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

Default: RemovalPolicy.DESTROY

builder

static VersionOptions.Builder builder()

Specified by:

builder in interface EventInvokeConfigOptions

Returns:

a VersionOptions.Builder of VersionOptions