AWS CDK Reference

Appearance

v2.273.0

RuntimeManagementMode Class ​

Specify the runtime update mode.

Source
aws-lambda/lib/runtime-management.ts
Type last changed
v2.64.0 · 9 Feb 2023

Example ​

ts
new lambda.Function(this, 'Lambda', {
  runtimeManagementMode: lambda.RuntimeManagementMode.AUTO,
  runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
});

Properties ​

arnstringarnstrarnStringArnstringArn*string#
AUTORuntimeManagementModeautoRuntimeManagementModeAUTORuntimeManagementModeAUTORuntimeManagementModeAUTORuntimeManagementModerequiredstatic#
Automatically update to the most recent and secure runtime version using Two-phase runtime version rollout.

We recommend this mode for most customers so that you always benefit from runtime updates.

FUNCTION_UPDATERuntimeManagementModefunction_updateRuntimeManagementModeFUNCTION_UPDATERuntimeManagementModeFUNCTION_UPDATERuntimeManagementModeFUNCTION_UPDATERuntimeManagementModerequiredstatic#
When you update your function, Lambda updates the runtime of your function to the most recent and secure runtime version.
notes

This approach synchronizes runtime updates with function deployments, giving you control over when Lambda applies runtime updates. With this mode, you can detect and mitigate rare runtime update incompatibilities early. When using this mode, you must regularly update your functions to keep their runtime up to date.

modestringmodestrmodeStringModestringMode*stringrequired#
runtimeManagementConfigCfnFunction.RuntimeManagementConfigPropertyruntime_management_configRuntimeManagementConfigPropertyruntimeManagementConfigRuntimeManagementConfigPropertyRuntimeManagementConfigRuntimeManagementConfigPropertyRuntimeManagementConfigRuntimeManagementConfigPropertyrequired#
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html.

Methods ​

manual(arn: string): RuntimeManagementMode // chainable@staticmethod def manual(arn: str) -> RuntimeManagementModepublic static RuntimeManagementMode manual(String arn)public static RuntimeManagementMode Manual(string arn)func Manual(Arn *string) RuntimeManagementModestatic#
You specify a runtime version in your function configuration.

The function uses this runtime version indefinitely. In the rare case in which a new runtime version is incompatible with an existing function, you can use this mode to roll back your function to an earlier runtime version.