Skip to content

Commit ed86c66

Browse files
authored
docs: recommend lambda runtime nodejs12.x (#12807)
Follow-up to #12713 This PR recommends NODEJS_12_X instead of NODEJS_10_X in aws-cdk READMEs. Reasons for recommending NODEJS_12_X: * Node.js 10.x is going end-of-life on April 30th, 2021 * Node.js 12.x went LTS in October 2019, and has been actively supported till October 2020. * Node.js 14.x went LTS in October 2020, and is now actively supported LTS version. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 3599247 commit ed86c66

File tree

11 files changed

+25
-25
lines changed

11 files changed

+25
-25
lines changed

packages/@aws-cdk/aws-apigateway/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The following example shows how to use an API Key with a usage plan:
163163

164164
```ts
165165
const hello = new lambda.Function(this, 'hello', {
166-
runtime: lambda.Runtime.NODEJS_10_X,
166+
runtime: lambda.Runtime.NODEJS_12_X,
167167
handler: 'hello.handler',
168168
code: lambda.Code.fromAsset('lambda')
169169
});
@@ -230,7 +230,7 @@ The following example shows how to use a rate limited api key :
230230

231231
```ts
232232
const hello = new lambda.Function(this, 'hello', {
233-
runtime: lambda.Runtime.NODEJS_10_X,
233+
runtime: lambda.Runtime.NODEJS_12_X,
234234
handler: 'hello.handler',
235235
code: lambda.Code.fromAsset('lambda')
236236
});
@@ -260,7 +260,7 @@ have to define your models and mappings for the request, response, and integrati
260260

261261
```ts
262262
const hello = new lambda.Function(this, 'hello', {
263-
runtime: lambda.Runtime.NODEJS_10_X,
263+
runtime: lambda.Runtime.NODEJS_12_X,
264264
handler: 'hello.handler',
265265
code: lambda.Code.fromAsset('lambda')
266266
});

packages/@aws-cdk/aws-cloudfront/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ The following shows a Lambda@Edge function added to the default behavior and tri
282282

283283
```ts
284284
const myFunc = new cloudfront.experimental.EdgeFunction(this, 'MyFunction', {
285-
runtime: lambda.Runtime.NODEJS_10_X,
285+
runtime: lambda.Runtime.NODEJS_12_X,
286286
handler: 'index.handler',
287287
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
288288
});
@@ -310,7 +310,7 @@ If the stack is in `us-east-1`, a "normal" `lambda.Function` can be used instead
310310

311311
```ts
312312
const myFunc = new lambda.Function(this, 'MyFunction', {
313-
runtime: lambda.Runtime.NODEJS_10_X,
313+
runtime: lambda.Runtime.NODEJS_12_X,
314314
handler: 'index.handler',
315315
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
316316
});
@@ -321,14 +321,14 @@ you can also set a specific stack ID for each Lambda@Edge.
321321

322322
```ts
323323
const myFunc1 = new cloudfront.experimental.EdgeFunction(this, 'MyFunction1', {
324-
runtime: lambda.Runtime.NODEJS_10_X,
324+
runtime: lambda.Runtime.NODEJS_12_X,
325325
handler: 'index.handler',
326326
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler1')),
327327
stackId: 'edge-lambda-stack-id-1'
328328
});
329329

330330
const myFunc2 = new cloudfront.experimental.EdgeFunction(this, 'MyFunction2', {
331-
runtime: lambda.Runtime.NODEJS_10_X,
331+
runtime: lambda.Runtime.NODEJS_12_X,
332332
handler: 'index.handler',
333333
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler2')),
334334
stackId: 'edge-lambda-stack-id-2'

packages/@aws-cdk/aws-cloudtrail/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ configures logging of Lambda data events for a specific Function.
175175
```ts
176176
const trail = new cloudtrail.Trail(this, 'MyAmazingCloudTrail');
177177
const amazingFunction = new lambda.Function(stack, 'AnAmazingFunction', {
178-
runtime: lambda.Runtime.NODEJS_10_X,
178+
runtime: lambda.Runtime.NODEJS_12_X,
179179
handler: "hello.handler",
180180
code: lambda.Code.fromAsset("lambda"),
181181
});

packages/@aws-cdk/aws-codepipeline-actions/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,7 @@ const lambdaCode = lambda.Code.fromCfnParameters();
629629
const func = new lambda.Function(lambdaStack, 'Lambda', {
630630
code: lambdaCode,
631631
handler: 'index.handler',
632-
runtime: lambda.Runtime.NODEJS_10_X,
632+
runtime: lambda.Runtime.NODEJS_12_X,
633633
});
634634
// used to make sure each CDK synthesis produces a different Version
635635
const version = func.addVersion('NewVersion');
@@ -921,7 +921,7 @@ import * as lambda from '@aws-cdk/aws-lambda';
921921
const lambdaInvokeAction = new codepipeline_actions.LambdaInvokeAction({
922922
actionName: 'Lambda',
923923
lambda: new lambda.Function(this, 'Func', {
924-
runtime: lambda.Runtime.NODEJS_10_X,
924+
runtime: lambda.Runtime.NODEJS_12_X,
925925
handler: 'index.handler',
926926
code: lambda.Code.fromInline(`
927927
const AWS = require('aws-sdk');

packages/@aws-cdk/aws-cognito/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ on the construct, as so -
343343

344344
```ts
345345
const authChallengeFn = new lambda.Function(this, 'authChallengeFn', {
346-
runtime: lambda.Runtime.NODEJS_10_X,
346+
runtime: lambda.Runtime.NODEJS_12_X,
347347
handler: 'index.handler',
348348
code: lambda.Code.fromInline('auth challenge'),
349349
});
@@ -357,7 +357,7 @@ const userpool = new cognito.UserPool(this, 'myuserpool', {
357357
});
358358

359359
userpool.addTrigger(cognito.UserPoolOperation.USER_MIGRATION, new lambda.Function(this, 'userMigrationFn', {
360-
runtime: lambda.Runtime.NODEJS_10_X,
360+
runtime: lambda.Runtime.NODEJS_12_X,
361361
handler: 'index.handler',
362362
code: lambda.Code.fromInline('user migration'),
363363
}));

packages/@aws-cdk/aws-config/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ import * as targets from '@aws-cdk/aws-events-targets';
237237
const evalComplianceFn = new lambda.Function(this, 'CustomFunction', {
238238
code: lambda.AssetCode.fromInline('exports.handler = (event) => console.log(event);'),
239239
handler: 'index.handler',
240-
runtime: lambda.Runtime.NODEJS_10_X,
240+
runtime: lambda.Runtime.NODEJS_12_X,
241241
});
242242

243243
// A custom rule that runs on configuration changes of EC2 instances

packages/@aws-cdk/aws-lambda/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import * as lambda from '@aws-cdk/aws-lambda';
1818
import * as path from 'path';
1919

2020
const fn = new lambda.Function(this, 'MyFunction', {
21-
runtime: lambda.Runtime.NODEJS_10_X,
21+
runtime: lambda.Runtime.NODEJS_12_X,
2222
handler: 'index.handler',
2323
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
2424
});
@@ -88,7 +88,7 @@ function. To reference the autogenerated Role:
8888

8989
```ts
9090
const fn = new lambda.Function(this, 'MyFunction', {
91-
runtime: lambda.Runtime.NODEJS_10_X,
91+
runtime: lambda.Runtime.NODEJS_12_X,
9292
handler: 'index.handler',
9393
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
9494

@@ -101,7 +101,7 @@ it appropriate permissions:
101101
102102
```ts
103103
const fn = new lambda.Function(this, 'MyFunction', {
104-
runtime: lambda.Runtime.NODEJS_10_X,
104+
runtime: lambda.Runtime.NODEJS_12_X,
105105
handler: 'index.handler',
106106
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
107107
role: myRole // user-provided role
@@ -251,7 +251,7 @@ setting the `deadLetterQueueEnabled: true` configuration.
251251
import * as lambda from '@aws-cdk/aws-lambda';
252252

253253
const fn = new lambda.Function(this, 'MyFunction', {
254-
runtime: lambda.Runtime.NODEJS_10_X,
254+
runtime: lambda.Runtime.NODEJS_12_X,
255255
handler: 'index.handler',
256256
code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, "hi"); }'),
257257
deadLetterQueueEnabled: true
@@ -266,7 +266,7 @@ import * as sqs from '@aws-cdk/aws-sqs';
266266

267267
const dlq = new sqs.Queue(this, 'DLQ');
268268
const fn = new lambda.Function(this, 'MyFunction', {
269-
runtime: lambda.Runtime.NODEJS_10_X,
269+
runtime: lambda.Runtime.NODEJS_12_X,
270270
handler: 'index.handler',
271271
code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, "hi"); }'),
272272
deadLetterQueue: dlq
@@ -282,7 +282,7 @@ to learn more about AWS Lambdas and DLQs.
282282
import * as lambda from '@aws-cdk/aws-lambda';
283283

284284
const fn = new lambda.Function(this, 'MyFunction', {
285-
runtime: lambda.Runtime.NODEJS_10_X,
285+
runtime: lambda.Runtime.NODEJS_12_X,
286286
handler: 'index.handler',
287287
code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, "hi"); }'),
288288
tracing: lambda.Tracing.ACTIVE
@@ -321,7 +321,7 @@ to learn more about AWS Lambda's Profiling support.
321321
import * as lambda from '@aws-cdk/aws-lambda';
322322

323323
const fn = new lambda.Function(this, 'MyFunction', {
324-
runtime: lambda.Runtime.NODEJS_10_X,
324+
runtime: lambda.Runtime.NODEJS_12_X,
325325
handler: 'index.handler',
326326
code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, "hi"); }'),
327327
reservedConcurrentExecutions: 100

packages/@aws-cdk/aws-rds/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ const cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {
525525
});
526526

527527
const fn = new lambda.Function(this, 'MyFunction', {
528-
runtime: lambda.Runtime.NODEJS_10_X,
528+
runtime: lambda.Runtime.NODEJS_12_X,
529529
handler: 'index.handler',
530530
code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
531531
environment: {

packages/@aws-cdk/aws-sns-subscriptions/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ import * as subscriptions from '@aws-cdk/aws-sns-subscriptions';
7878

7979
const myFunction = new lambda.Function(this, 'Echo', {
8080
handler: 'index.handler',
81-
runtime: lambda.Runtime.NODEJS_10_X,
81+
runtime: lambda.Runtime.NODEJS_12_X,
8282
code: lambda.Code.fromInline(`exports.handler = ${handler.toString()}`)
8383
});
8484

packages/@aws-cdk/aws-stepfunctions-tasks/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ const convertToSeconds = new tasks.EvaluateExpression(this, 'Convert to seconds'
189189
const createMessage = new tasks.EvaluateExpression(this, 'Create message', {
190190
// Note: this is a string inside a string.
191191
expression: '`Now waiting ${$.waitSeconds} seconds...`',
192-
runtime: lambda.Runtime.NODEJS_10_X,
192+
runtime: lambda.Runtime.NODEJS_12_X,
193193
resultPath: '$.message',
194194
});
195195

@@ -213,7 +213,7 @@ new sfn.StateMachine(this, 'StateMachine', {
213213

214214
The `EvaluateExpression` supports a `runtime` prop to specify the Lambda
215215
runtime to use to evaluate the expression. Currently, the only runtime
216-
supported is `lambda.Runtime.NODEJS_10_X`.
216+
supported is `lambda.Runtime.NODEJS_12_X`.
217217

218218

219219
## Athena

packages/aws-cdk/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Usage of output in a CDK stack
207207
const fn = new lambda.Function(this, "fn", {
208208
handler: "index.handler",
209209
code: lambda.Code.fromInline(`exports.handler = \${handler.toString()}`),
210-
runtime: lambda.Runtime.NODEJS_10_X
210+
runtime: lambda.Runtime.NODEJS_12_X
211211
});
212212

213213
new cdk.CfnOutput(this, 'FunctionArn', {

0 commit comments

Comments
 (0)