Package software.amazon.awscdk.services.lambda

Class Runtime

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.Runtime

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.285Z")
@Stability(Stable)
public class Runtime
extends software.amazon.jsii.JsiiObject

Lambda function runtime environment.

If you need to use a runtime name that doesn't exist as a static member, you can instantiate a Runtime object, e.g: new Runtime('nodejs99.99').

Example:

 import software.amazon.awscdk.services.signer.*;
 SigningProfile signingProfile = SigningProfile.Builder.create(this, "SigningProfile")
         .platform(Platform.AWS_LAMBDA_SHA384_ECDSA)
         .build();
 CodeSigningConfig codeSigningConfig = CodeSigningConfig.Builder.create(this, "CodeSigningConfig")
         .signingProfiles(List.of(signingProfile))
         .build();
 Function.Builder.create(this, "Function")
         .codeSigningConfig(codeSigningConfig)
         .runtime(Runtime.NODEJS_18_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Runtime.Builder	A fluent builder for Runtime.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static final List<Runtime>	ALL	A list of all known Runtime's.
static final Runtime	DOTNET_6	The .NET 6 runtime (dotnet6).
static final Runtime	DOTNET_8	The .NET 8 runtime (dotnet8).
static final Runtime	DOTNET_CORE_1	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	DOTNET_CORE_2	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	DOTNET_CORE_2_1	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	DOTNET_CORE_3_1	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	FROM_IMAGE	A special runtime entry to be used when function is using a docker image.
static final Runtime	GO_1_X	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	JAVA_11	The Java 11 runtime (java11).
static final Runtime	JAVA_17	The Java 17 runtime (java17).
static final Runtime	JAVA_21	The Java 21 runtime (java21).
static final Runtime	JAVA_8	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	JAVA_8_CORRETTO	The Java 8 Corretto runtime (java8.al2).
static final Runtime	NODEJS	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	NODEJS_10_X	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	NODEJS_12_X	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	NODEJS_14_X	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	NODEJS_16_X	The NodeJS 16.x runtime (nodejs16.x).
static final Runtime	NODEJS_18_X	The NodeJS 18.x runtime (nodejs18.x).
static final Runtime	NODEJS_20_X	The NodeJS 20.x runtime (nodejs20.x).
static final Runtime	NODEJS_4_3	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	NODEJS_6_10	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	NODEJS_8_10	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	NODEJS_LATEST	The latest NodeJS version currently available in ALL regions (not necessarily the latest NodeJS version available in YOUR region).
static final Runtime	PROVIDED	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	PROVIDED_AL2	The custom provided runtime with Amazon Linux 2 (provided.al2).
static final Runtime	PROVIDED_AL2023	The custom provided runtime with Amazon Linux 2023 (provided.al2023).
static final Runtime	PYTHON_2_7	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	PYTHON_3_10	The Python 3.10 runtime (python3.10).
static final Runtime	PYTHON_3_11	The Python 3.11 runtime (python3.11).
static final Runtime	PYTHON_3_12	The Python 3.12 runtime (python3.12).
static final Runtime	PYTHON_3_6	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	PYTHON_3_7	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	PYTHON_3_8	The Python 3.8 runtime (python3.8).
static final Runtime	PYTHON_3_9	The Python 3.9 runtime (python3.9).
static final Runtime	RUBY_2_5	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	RUBY_2_7	Deprecated. Legacy runtime no longer supported by AWS Lambda.
static final Runtime	RUBY_3_2	The Ruby 3.2 runtime (ruby3.2).
static final Runtime	RUBY_3_3	The Ruby 3.3 runtime (ruby3.3).

Constructor Summary

Constructors

Modifier	Constructor	Description
	Runtime(String name)
	Runtime(String name, RuntimeFamily family)
	Runtime(String name, RuntimeFamily family, LambdaRuntimeProps props)
protected	Runtime(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Runtime(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
DockerImage	getBundlingImage()	The bundling Docker image for this runtime.
RuntimeFamily	getFamily()	The runtime family.
Boolean	getIsVariable()	Enabled for runtime enums that always target the latest available.
String	getName()	The name of this runtime, as expected by the Lambda resource.
Boolean	getSupportsCodeGuruProfiling()	Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler.
Boolean	getSupportsInlineCode()	Whether the ZipFile (aka inline code) property can be used with this runtime.
Boolean	getSupportsSnapStart()	Whether this runtime supports snapstart.
Boolean	runtimeEquals(Runtime other)
String	toString()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

ALL

@Stability(Stable)
public static final List<Runtime> ALL

A list of all known Runtime's.

DOTNET_6

@Stability(Stable)
public static final Runtime DOTNET_6

The .NET 6 runtime (dotnet6).

DOTNET_8

@Stability(Stable)
public static final Runtime DOTNET_8

The .NET 8 runtime (dotnet8).

DOTNET_CORE_1

@Stability(Deprecated)
@Deprecated
public static final Runtime DOTNET_CORE_1

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.

(deprecated) The .NET Core 1.0 runtime (dotnetcore1.0).

DOTNET_CORE_2

@Stability(Deprecated)
@Deprecated
public static final Runtime DOTNET_CORE_2

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.

(deprecated) The .NET Core 2.0 runtime (dotnetcore2.0).

DOTNET_CORE_2_1

@Stability(Deprecated)
@Deprecated
public static final Runtime DOTNET_CORE_2_1

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.

(deprecated) The .NET Core 2.1 runtime (dotnetcore2.1).

DOTNET_CORE_3_1

@Stability(Deprecated)
@Deprecated
public static final Runtime DOTNET_CORE_3_1

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.

(deprecated) The .NET Core 3.1 runtime (dotnetcore3.1).

FROM_IMAGE

@Stability(Stable)
public static final Runtime FROM_IMAGE

A special runtime entry to be used when function is using a docker image.

GO_1_X

@Stability(Deprecated)
@Deprecated
public static final Runtime GO_1_X

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the PROVIDED_AL2023 runtime.

(deprecated) The Go 1.x runtime (go1.x).

JAVA_11

@Stability(Stable)
public static final Runtime JAVA_11

The Java 11 runtime (java11).

JAVA_17

@Stability(Stable)
public static final Runtime JAVA_17

The Java 17 runtime (java17).

JAVA_21

@Stability(Stable)
public static final Runtime JAVA_21

The Java 21 runtime (java21).

JAVA_8

@Stability(Deprecated)
@Deprecated
public static final Runtime JAVA_8

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Java runtime.

(deprecated) The Java 8 runtime (java8).

JAVA_8_CORRETTO

@Stability(Stable)
public static final Runtime JAVA_8_CORRETTO

The Java 8 Corretto runtime (java8.al2).

NODEJS

@Stability(Deprecated)
@Deprecated
public static final Runtime NODEJS

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

(deprecated) The NodeJS runtime (nodejs).

NODEJS_10_X

@Stability(Deprecated)
@Deprecated
public static final Runtime NODEJS_10_X

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

(deprecated) The NodeJS 10.x runtime (nodejs10.x).

NODEJS_12_X

@Stability(Deprecated)
@Deprecated
public static final Runtime NODEJS_12_X

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

(deprecated) The NodeJS 12.x runtime (nodejs12.x).

NODEJS_14_X

@Stability(Deprecated)
@Deprecated
public static final Runtime NODEJS_14_X

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

(deprecated) The NodeJS 14.x runtime (nodejs14.x).

NODEJS_16_X

@Stability(Stable)
public static final Runtime NODEJS_16_X

The NodeJS 16.x runtime (nodejs16.x).

NODEJS_18_X

@Stability(Stable)
public static final Runtime NODEJS_18_X

The NodeJS 18.x runtime (nodejs18.x).

NODEJS_20_X

@Stability(Stable)
public static final Runtime NODEJS_20_X

The NodeJS 20.x runtime (nodejs20.x).

NODEJS_4_3

@Stability(Deprecated)
@Deprecated
public static final Runtime NODEJS_4_3

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

(deprecated) The NodeJS 4.3 runtime (nodejs4.3).

NODEJS_6_10

@Stability(Deprecated)
@Deprecated
public static final Runtime NODEJS_6_10

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

(deprecated) The NodeJS 6.10 runtime (nodejs6.10).

NODEJS_8_10

@Stability(Deprecated)
@Deprecated
public static final Runtime NODEJS_8_10

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

(deprecated) The NodeJS 8.10 runtime (nodejs8.10).

NODEJS_LATEST

@Stability(Stable)
public static final Runtime NODEJS_LATEST

The latest NodeJS version currently available in ALL regions (not necessarily the latest NodeJS version available in YOUR region).

PROVIDED

@Stability(Deprecated)
@Deprecated
public static final Runtime PROVIDED

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest provided.al2023 runtime.

(deprecated) The custom provided runtime (provided).

PROVIDED_AL2

@Stability(Stable)
public static final Runtime PROVIDED_AL2

The custom provided runtime with Amazon Linux 2 (provided.al2).

PROVIDED_AL2023

@Stability(Stable)
public static final Runtime PROVIDED_AL2023

The custom provided runtime with Amazon Linux 2023 (provided.al2023).

PYTHON_2_7

@Stability(Deprecated)
@Deprecated
public static final Runtime PYTHON_2_7

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.

(deprecated) The Python 2.7 runtime (python2.7).

PYTHON_3_10

@Stability(Stable)
public static final Runtime PYTHON_3_10

The Python 3.10 runtime (python3.10).

PYTHON_3_11

@Stability(Stable)
public static final Runtime PYTHON_3_11

The Python 3.11 runtime (python3.11).

PYTHON_3_12

@Stability(Stable)
public static final Runtime PYTHON_3_12

The Python 3.12 runtime (python3.12).

PYTHON_3_6

@Stability(Deprecated)
@Deprecated
public static final Runtime PYTHON_3_6

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.

(deprecated) The Python 3.6 runtime (python3.6) (not recommended).

The Python 3.6 runtime is deprecated as of July 2022.

PYTHON_3_7

@Stability(Deprecated)
@Deprecated
public static final Runtime PYTHON_3_7

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.

(deprecated) The Python 3.7 runtime (python3.7).

PYTHON_3_8

@Stability(Stable)
public static final Runtime PYTHON_3_8

The Python 3.8 runtime (python3.8).

PYTHON_3_9

@Stability(Stable)
public static final Runtime PYTHON_3_9

The Python 3.9 runtime (python3.9).

RUBY_2_5

@Stability(Deprecated)
@Deprecated
public static final Runtime RUBY_2_5

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Ruby runtime.

(deprecated) The Ruby 2.5 runtime (ruby2.5).

RUBY_2_7

@Stability(Deprecated)
@Deprecated
public static final Runtime RUBY_2_7

Deprecated.

Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Ruby runtime.

(deprecated) The Ruby 2.7 runtime (ruby2.7).

RUBY_3_2

@Stability(Stable)
public static final Runtime RUBY_3_2

The Ruby 3.2 runtime (ruby3.2).

RUBY_3_3

@Stability(Stable)
public static final Runtime RUBY_3_3

The Ruby 3.3 runtime (ruby3.3).

Constructor Details

Runtime

protected Runtime(software.amazon.jsii.JsiiObjectRef objRef)

Runtime

protected Runtime(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Runtime

@Stability(Stable)
public Runtime(@NotNull
 String name,
 @Nullable
 RuntimeFamily family,
 @Nullable
 LambdaRuntimeProps props)

Parameters:

name - This parameter is required.

family -

props -

Runtime

@Stability(Stable)
public Runtime(@NotNull
 String name,
 @Nullable
 RuntimeFamily family)

Parameters:

name - This parameter is required.

family -

Runtime

@Stability(Stable)
public Runtime(@NotNull
 String name)

Parameters:

name - This parameter is required.

Method Details

runtimeEquals

@Stability(Stable)
@NotNull
public Boolean runtimeEquals(@NotNull
 Runtime other)

Parameters:

other - This parameter is required.

toString

@Stability(Stable)
@NotNull
public String toString()

Overrides:

toString in class Object

getBundlingImage

@Stability(Stable)
@NotNull
public DockerImage getBundlingImage()

The bundling Docker image for this runtime.

getIsVariable

@Stability(Stable)
@NotNull
public Boolean getIsVariable()

Enabled for runtime enums that always target the latest available.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of this runtime, as expected by the Lambda resource.

getSupportsCodeGuruProfiling

@Stability(Stable)
@NotNull
public Boolean getSupportsCodeGuruProfiling()

Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler.

getSupportsInlineCode

@Stability(Stable)
@NotNull
public Boolean getSupportsInlineCode()

Whether the ZipFile (aka inline code) property can be used with this runtime.

getSupportsSnapStart

@Stability(Stable)
@NotNull
public Boolean getSupportsSnapStart()

Whether this runtime supports snapstart.

getFamily

@Stability(Stable)
@Nullable
public RuntimeFamily getFamily()

The runtime family.