Package software.amazon.awscdk.services.lambda

Interface CfnFunction.RuntimeManagementConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFunction.RuntimeManagementConfigProperty.Jsii$Proxy
Enclosing class:
CfnFunction
@Stability(Stable) public static interface CfnFunction.RuntimeManagementConfigProperty extends software.amazon.jsii.JsiiSerializable
Sets the runtime management configuration for a function's version.

For more information, see Runtime updates .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 RuntimeManagementConfigProperty runtimeManagementConfigProperty = RuntimeManagementConfigProperty.builder()
         .updateRuntimeOn("updateRuntimeOn")
         // the properties below are optional
         .runtimeVersionArn("runtimeVersionArn")
         .build();

  • Method Details

    • getUpdateRuntimeOn

      @Stability(Stable) @NotNull String getUpdateRuntimeOn()
      Specify the runtime update mode.

      • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout . This is the best choice for most customers to ensure they always benefit from runtime updates.
      • FunctionUpdate - Lambda updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
      • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version .

      Valid Values : Auto | FunctionUpdate | Manual

    • getRuntimeVersionArn

      @Stability(Stable) @Nullable default String getRuntimeVersionArn()
      The ARN of the runtime version you want the function to use.

      This is only required if you're using the Manual runtime update mode.

    • builder

      @Stability(Stable) static CfnFunction.RuntimeManagementConfigProperty.Builder builder()
      Returns:
      a CfnFunction.RuntimeManagementConfigProperty.Builder of CfnFunction.RuntimeManagementConfigProperty