UNPKG

6.04 kBTypeScriptView Raw
1import { BundlingDockerImage, DockerImage } from '@aws-cdk/core';
2export interface LambdaRuntimeProps {
3 /**
4 * Whether the ``ZipFile`` (aka inline code) property can be used with this runtime.
5 * @default false
6 */
7 readonly supportsInlineCode?: boolean;
8 /**
9 * The Docker image name to be used for bundling in this runtime.
10 * @default - the latest docker image "amazon/public.ecr.aws/sam/build-<runtime>" from https://gallery.ecr.aws
11 */
12 readonly bundlingDockerImage?: string;
13 /**
14 * Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler.
15 * @default false
16 */
17 readonly supportsCodeGuruProfiling?: boolean;
18}
19export declare enum RuntimeFamily {
20 NODEJS = 0,
21 JAVA = 1,
22 PYTHON = 2,
23 DOTNET_CORE = 3,
24 GO = 4,
25 RUBY = 5,
26 OTHER = 6
27}
28/**
29 * Lambda function runtime environment.
30 *
31 * If you need to use a runtime name that doesn't exist as a static member, you
32 * can instantiate a `Runtime` object, e.g: `new Runtime('nodejs99.99')`.
33 */
34export declare class Runtime {
35 /** A list of all known `Runtime`'s. */
36 static readonly ALL: Runtime[];
37 /**
38 * The NodeJS runtime (nodejs)
39 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.
40 */
41 static readonly NODEJS: Runtime;
42 /**
43 * The NodeJS 4.3 runtime (nodejs4.3)
44 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.
45 */
46 static readonly NODEJS_4_3: Runtime;
47 /**
48 * The NodeJS 6.10 runtime (nodejs6.10)
49 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.
50 */
51 static readonly NODEJS_6_10: Runtime;
52 /**
53 * The NodeJS 8.10 runtime (nodejs8.10)
54 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.
55 */
56 static readonly NODEJS_8_10: Runtime;
57 /**
58 * The NodeJS 10.x runtime (nodejs10.x)
59 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.
60 */
61 static readonly NODEJS_10_X: Runtime;
62 /**
63 * The NodeJS 12.x runtime (nodejs12.x)
64 */
65 static readonly NODEJS_12_X: Runtime;
66 /**
67 * The NodeJS 14.x runtime (nodejs14.x)
68 */
69 static readonly NODEJS_14_X: Runtime;
70 /**
71 * The NodeJS 16.x runtime (nodejs16.x)
72 */
73 static readonly NODEJS_16_X: Runtime;
74 /**
75 * The Python 2.7 runtime (python2.7)
76 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.
77 */
78 static readonly PYTHON_2_7: Runtime;
79 /**
80 * The Python 3.6 runtime (python3.6) (not recommended)
81 *
82 * The Python 3.6 runtime is deprecated as of July 2022.
83 *
84 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.
85 */
86 static readonly PYTHON_3_6: Runtime;
87 /**
88 * The Python 3.7 runtime (python3.7)
89 */
90 static readonly PYTHON_3_7: Runtime;
91 /**
92 * The Python 3.8 runtime (python3.8)
93 */
94 static readonly PYTHON_3_8: Runtime;
95 /**
96 * The Python 3.9 runtime (python3.9)
97 */
98 static readonly PYTHON_3_9: Runtime;
99 /**
100 * The Java 8 runtime (java8)
101 */
102 static readonly JAVA_8: Runtime;
103 /**
104 * The Java 8 Corretto runtime (java8.al2)
105 */
106 static readonly JAVA_8_CORRETTO: Runtime;
107 /**
108 * The Java 11 runtime (java11)
109 */
110 static readonly JAVA_11: Runtime;
111 /**
112 * The .NET 6 runtime (dotnet6)
113 */
114 static readonly DOTNET_6: Runtime;
115 /**
116 * The .NET Core 1.0 runtime (dotnetcore1.0)
117 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.
118 */
119 static readonly DOTNET_CORE_1: Runtime;
120 /**
121 * The .NET Core 2.0 runtime (dotnetcore2.0)
122 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.
123 */
124 static readonly DOTNET_CORE_2: Runtime;
125 /**
126 * The .NET Core 2.1 runtime (dotnetcore2.1)
127 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.
128 */
129 static readonly DOTNET_CORE_2_1: Runtime;
130 /**
131 * The .NET Core 3.1 runtime (dotnetcore3.1)
132 */
133 static readonly DOTNET_CORE_3_1: Runtime;
134 /**
135 * The Go 1.x runtime (go1.x)
136 */
137 static readonly GO_1_X: Runtime;
138 /**
139 * The Ruby 2.5 runtime (ruby2.5)
140 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Ruby runtime.
141 */
142 static readonly RUBY_2_5: Runtime;
143 /**
144 * The Ruby 2.7 runtime (ruby2.7)
145 */
146 static readonly RUBY_2_7: Runtime;
147 /**
148 * The custom provided runtime (provided)
149 */
150 static readonly PROVIDED: Runtime;
151 /**
152 * The custom provided runtime (provided)
153 */
154 static readonly PROVIDED_AL2: Runtime;
155 /**
156 * A special runtime entry to be used when function is using a docker image.
157 */
158 static readonly FROM_IMAGE: Runtime;
159 /**
160 * The name of this runtime, as expected by the Lambda resource.
161 */
162 readonly name: string;
163 /**
164 * Whether the ``ZipFile`` (aka inline code) property can be used with this
165 * runtime.
166 */
167 readonly supportsInlineCode: boolean;
168 /**
169 * Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler.
170 */
171 readonly supportsCodeGuruProfiling: boolean;
172 /**
173 * The runtime family.
174 */
175 readonly family?: RuntimeFamily;
176 /**
177 * DEPRECATED
178 * @deprecated use `bundlingImage`
179 */
180 readonly bundlingDockerImage: BundlingDockerImage;
181 /**
182 * The bundling Docker image for this runtime.
183 */
184 readonly bundlingImage: DockerImage;
185 constructor(name: string, family?: RuntimeFamily, props?: LambdaRuntimeProps);
186 toString(): string;
187 runtimeEquals(other: Runtime): boolean;
188}