feat: Support RuntimeManagementConfig

Author: aahung

.cfnlintrc.yaml

@@ -114,6 +114,8 @@ ignore_templates:
   - tests/translator/output/**/state_machine_with_event_schedule_state.json
   - tests/translator/output/**/state_machine_with_schedule.json
   - tests/translator/output/**/state_machine_with_schedule_dlq_retry_policy.json
+  - tests/translator/output/**/globals_for_function.json  # RuntimeManagementConfig
+  - tests/translator/output/**/function_with_runtime_config.json  # RuntimeManagementConfig
 ignore_checks:
   - E2531 # Deprecated runtime; not relevant for transform tests
   - W2531 # EOL runtime; not relevant for transform tests

docs/globals.rst

@@ -73,6 +73,7 @@ Currently, the following resources and properties are being supported:
       EventInvokeConfig:
       Architectures:
       EphemeralStorage:
+      RuntimeManagementConfig:
 
     Api:
       # Properties of AWS::Serverless::Api

samtranslator/model/lambda_.py

@@ -31,6 +31,7 @@ class LambdaFunction(Resource):
         "Architectures": PropertyType(False, list_of(one_of(IS_STR, IS_DICT))),
         "SnapStart": PropertyType(False, IS_DICT),
         "EphemeralStorage": PropertyType(False, IS_DICT),
+        "RuntimeManagementConfig": PropertyType(False, IS_DICT),
     }
 
     Code: Dict[str, Any]
@@ -56,6 +57,7 @@ class LambdaFunction(Resource):
     Architectures: Optional[List[Any]]
     SnapStart: Optional[Dict[str, Any]]
     EphemeralStorage: Optional[Dict[str, Any]]
+    RuntimeManagementConfig: Optional[Dict[str, Any]]
 
     runtime_attrs = {"name": lambda self: ref(self.logical_id), "arn": lambda self: fnGetAtt(self.logical_id, "Arn")}
 
@@ -66,6 +68,7 @@ class LambdaVersion(Resource):
         "CodeSha256": PropertyType(False, IS_STR),
         "Description": PropertyType(False, IS_STR),
         "FunctionName": PropertyType(True, one_of(IS_STR, IS_DICT)),
+        "RuntimeManagementConfig": PropertyType(False, IS_DICT),
     }
 
     runtime_attrs = {

samtranslator/model/sam_resources.py

@@ -127,6 +127,7 @@ class SamFunction(SamResourceMacro):
         "Architectures": PropertyType(False, list_of(one_of(IS_STR, IS_DICT))),
         "SnapStart": PropertyType(False, IS_DICT),
         "FunctionUrlConfig": PropertyType(False, IS_DICT),
+        "RuntimeManagementConfig": PropertyType(False, IS_DICT),
     }
 
     FunctionName: Optional[Intrinsicable[str]]
@@ -530,6 +531,7 @@ def _construct_lambda_function(self) -> LambdaFunction:
 
         lambda_function.CodeSigningConfigArn = self.CodeSigningConfigArn
 
+        lambda_function.RuntimeManagementConfig = self.RuntimeManagementConfig  # type: ignore[attr-defined]
         self._validate_package_type(lambda_function)
         self._validate_architectures(lambda_function)
         return lambda_function
@@ -893,6 +895,8 @@ def _construct_version(
         lambda_version = LambdaVersion(logical_id=logical_id, attributes=attributes)
         lambda_version.FunctionName = function.get_runtime_attr("name")
         lambda_version.Description = self.VersionDescription
+        # Copy the same runtime policy for the version and the function
+        lambda_version.RuntimeManagementConfig = function.RuntimeManagementConfig
 
         return lambda_version
 

samtranslator/plugins/globals/globals.py

@@ -1,4 +1,4 @@
-from typing import Dict, List
+from typing import Dict, List
 
 from samtranslator.model.exceptions import ExceptionWithMessage
 from samtranslator.public.sdk.resource import SamResourceType
@@ -49,6 +49,7 @@ class Globals(object):
             "SnapStart",
             "EphemeralStorage",
             "FunctionUrlConfig",
+            "RuntimeManagementConfig",
         ],
         # Everything except
         #   DefinitionBody: because its hard to reason about merge of Swagger dictionaries
@@ -88,7 +89,7 @@ class Globals(object):
     }
     # unreleased_properties *must be* part of supported_properties too
     unreleased_properties: Dict[str, List[str]] = {
-        SamResourceType.Function.value: [],
+        SamResourceType.Function.value: ["RuntimeManagementConfig"],
     }
 
     def __init__(self, template):  # type: ignore[no-untyped-def]

samtranslator/schema/aws_serverless_function.py

@@ -445,6 +445,7 @@ class ScheduleV2Event(BaseModel):
 Architectures = Optional[PassThrough]
 EphemeralStorage = Optional[PassThrough]
 SnapStart = Optional[PassThrough]  # TODO: check the type
+RuntimeManagementConfig = Optional[PassThrough]  # TODO: check the type
 
 
 class Properties(BaseModel):
@@ -504,6 +505,7 @@ class Properties(BaseModel):
     Role: Optional[SamIntrinsicable[str]] = prop("Role")
     Runtime: Optional[Runtime] = prop("Runtime")
     SnapStart: Optional[SnapStart]  # TODO: add prop and types
+    RuntimeManagementConfig: Optional[RuntimeManagementConfig]  # TODO: add prop and types
     Tags: Optional[Tags] = prop("Tags")
     Timeout: Optional[Timeout] = prop("Timeout")
     Tracing: Optional[Tracing] = prop("Tracing")
@@ -536,6 +538,7 @@ class Globals(BaseModel):
     Architectures: Optional[Architectures] = prop("Architectures")
     EphemeralStorage: Optional[EphemeralStorage] = prop("EphemeralStorage")
     SnapStart: Optional[SnapStart]  # TODO: add prop
+    RuntimeManagementConfig: Optional[RuntimeManagementConfig]  # TODO: add prop
 
 
 class Resource(BaseModel):

samtranslator/schema/schema.json

@@ -532,6 +532,9 @@
         },
         "SnapStart": {
           "title": "Snapstart"
+        },
+        "RuntimeManagementConfig": {
+          "title": "Runtimemanagementconfig"
         }
       },
       "additionalProperties": false
@@ -4002,6 +4005,9 @@
         "SnapStart": {
           "title": "Snapstart"
         },
+        "RuntimeManagementConfig": {
+          "title": "Runtimemanagementconfig"
+        },
         "Tags": {
           "title": "Tags",
           "description": "A map \\(string to string\\) that specifies the tags added to this function\\. For details about valid keys and values for tags, see [Tag Key and Value Requirements](https://docs.aws.amazon.com/lambda/latest/dg/configuration-tags.html#configuration-tags-restrictions) in the *AWS Lambda Developer Guide*\\.  \nWhen the stack is created, AWS SAM automatically adds a `lambda:createdBy:SAM` tag to this Lambda function, and to the default roles that are generated for this function\\.  \n*Type*: Map  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is similar to the [`Tags`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags) property of an `AWS::Lambda::Function` resource\\. The `Tags` property in AWS SAM consists of key\\-value pairs \\(whereas in AWS CloudFormation this property consists of a list of `Tag` objects\\)\\. Also, AWS SAM automatically adds a `lambda:createdBy:SAM` tag to this Lambda function, and to the default roles that are generated for this function\\.",

tests/translator/input/function_with_runtime_config.yaml

@@ -0,0 +1,52 @@
+%YAML 1.1
+---
+Parameters:
+  RuntimeVersionParam:
+    Type: String
+  RuntimeUpdateParam:
+    Type: String
+
+Resources:
+  FunctionWithRuntimeManagementConfig:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: s3://sam-demo-bucket/hello.zip
+      Handler: hello.handler
+      Runtime: python3.8
+      RuntimeManagementConfig:
+        UpdateRuntimeOn: Auto
+  MinimalFunctionWithManualRuntimeManagementConfig:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: s3://sam-demo-bucket/hello.zip
+      Handler: hello.handler
+      Runtime: python3.8
+      RuntimeManagementConfig:
+        UpdateRuntimeOn: Manual
+        RuntimeVersionArn: !Sub arn:aws:lambda:${AWS::Region}::runtime:python3.8::0af1966588ced06e3143ae720245c9b7aeaae213c6921c12c742a166679cc505
+  FunctionWithRuntimeManagementConfigAndAlias:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: s3://sam-demo-bucket/hello.zip
+      Handler: hello.handler
+      Runtime: python3.8
+      AutoPublishAlias: live
+      RuntimeManagementConfig:
+        UpdateRuntimeOn: Auto
+  FunctionWithIntrinsicUpdateRuntimeOn:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: s3://sam-demo-bucket/hello.zip
+      Handler: hello.handler
+      Runtime: python3.8
+      RuntimeManagementConfig:
+        UpdateRuntimeOn: !Ref RuntimeUpdateParam
+  FunctionWithIntrinsicRuntimeVersion:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: s3://sam-demo-bucket/hello.zip
+      Handler: hello.handler
+      Runtime: python3.8
+      RuntimeManagementConfig:
+        UpdateRuntimeOn: !Ref RuntimeUpdateParam
+        RuntimeVersionArn: !Ref RuntimeVersionParam

tests/translator/input/globals_for_function.yaml

@@ -28,6 +28,8 @@ Globals:
       ApplyOn: PublishedVersions
     EphemeralStorage:
       Size: 1024
+    RuntimeManagementConfig:
+      UpdateRuntimeOn: Auto
 
 Resources:
   MinimalFunction:
@@ -57,3 +59,5 @@ Resources:
       SnapStart:
         ApplyOn: None
       ReservedConcurrentExecutions: 100
+      RuntimeManagementConfig:
+        UpdateRuntimeOn: FunctionChange