UNPKG

5.84 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 Python 2.7 runtime (python2.7)
72 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.
73 */
74 static readonly PYTHON_2_7: Runtime;
75 /**
76 * The Python 3.6 runtime (python3.6)
77 * @deprecated Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.
78 */
79 static readonly PYTHON_3_6: Runtime;
80 /**
81 * The Python 3.7 runtime (python3.7)
82 */
83 static readonly PYTHON_3_7: Runtime;
84 /**
85 * The Python 3.8 runtime (python3.8)
86 */
87 static readonly PYTHON_3_8: Runtime;
88 /**
89 * The Python 3.9 runtime (python3.9)
90 */
91 static readonly PYTHON_3_9: Runtime;
92 /**
93 * The Java 8 runtime (java8)
94 */
95 static readonly JAVA_8: Runtime;
96 /**
97 * The Java 8 Corretto runtime (java8.al2)
98 */
99 static readonly JAVA_8_CORRETTO: Runtime;
100 /**
101 * The Java 11 runtime (java11)
102 */
103 static readonly JAVA_11: Runtime;
104 /**
105 * The .NET 6 runtime (dotnet6)
106 */
107 static readonly DOTNET_6: Runtime;
108 /**
109 * The .NET Core 1.0 runtime (dotnetcore1.0)
110 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.
111 */
112 static readonly DOTNET_CORE_1: Runtime;
113 /**
114 * The .NET Core 2.0 runtime (dotnetcore2.0)
115 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.
116 */
117 static readonly DOTNET_CORE_2: Runtime;
118 /**
119 * The .NET Core 2.1 runtime (dotnetcore2.1)
120 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.
121 */
122 static readonly DOTNET_CORE_2_1: Runtime;
123 /**
124 * The .NET Core 3.1 runtime (dotnetcore3.1)
125 */
126 static readonly DOTNET_CORE_3_1: Runtime;
127 /**
128 * The Go 1.x runtime (go1.x)
129 */
130 static readonly GO_1_X: Runtime;
131 /**
132 * The Ruby 2.5 runtime (ruby2.5)
133 * Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Ruby runtime.
134 */
135 static readonly RUBY_2_5: Runtime;
136 /**
137 * The Ruby 2.7 runtime (ruby2.7)
138 */
139 static readonly RUBY_2_7: Runtime;
140 /**
141 * The custom provided runtime (provided)
142 */
143 static readonly PROVIDED: Runtime;
144 /**
145 * The custom provided runtime (provided)
146 */
147 static readonly PROVIDED_AL2: Runtime;
148 /**
149 * A special runtime entry to be used when function is using a docker image.
150 */
151 static readonly FROM_IMAGE: Runtime;
152 /**
153 * The name of this runtime, as expected by the Lambda resource.
154 */
155 readonly name: string;
156 /**
157 * Whether the ``ZipFile`` (aka inline code) property can be used with this
158 * runtime.
159 */
160 readonly supportsInlineCode: boolean;
161 /**
162 * Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler.
163 */
164 readonly supportsCodeGuruProfiling: boolean;
165 /**
166 * The runtime family.
167 */
168 readonly family?: RuntimeFamily;
169 /**
170 * DEPRECATED
171 * @deprecated use `bundlingImage`
172 */
173 readonly bundlingDockerImage: BundlingDockerImage;
174 /**
175 * The bundling Docker image for this runtime.
176 */
177 readonly bundlingImage: DockerImage;
178 constructor(name: string, family?: RuntimeFamily, props?: LambdaRuntimeProps);
179 toString(): string;
180 runtimeEquals(other: Runtime): boolean;
181}