feat: Support Ignore Globals resource attribute (#3386)

Author: GavinZZ

samtranslator/internal/schema_source/aws_serverless_function.py

@@ -626,7 +626,7 @@ class Properties(BaseModel):
     SnapStart: Optional[SnapStart] = prop("SnapStart")
     RuntimeManagementConfig: Optional[RuntimeManagementConfig] = prop("RuntimeManagementConfig")
     Tags: Optional[Tags] = prop("Tags")
-    PropagateTags: Optional[bool]  # TODO: add docs
+    PropagateTags: Optional[bool] = prop("PropagateTags")
     Timeout: Optional[Timeout] = prop("Timeout")
     Tracing: Optional[Tracing] = prop("Tracing")
     VersionDescription: Optional[PassThroughProp] = prop("VersionDescription")
@@ -656,7 +656,7 @@ class Globals(BaseModel):
         ["AWS::Lambda::Function", "Properties", "Environment"],
     )
     Tags: Optional[Tags] = prop("Tags")
-    PropagateTags: Optional[bool]  # TODO: add docs
+    PropagateTags: Optional[bool] = prop("PropagateTags")
     Tracing: Optional[Tracing] = prop("Tracing")
     KmsKeyArn: Optional[KmsKeyArn] = prop("KmsKeyArn")
     Layers: Optional[Layers] = prop("Layers")

samtranslator/internal/schema_source/common.py

@@ -99,3 +99,4 @@ class ResourceAttributes(BaseModel):
     Metadata: Optional[PassThroughProp]
     UpdateReplacePolicy: Optional[PassThroughProp]
     Condition: Optional[PassThroughProp]
+    IgnoreGlobals: Optional[Union[str, List[str]]]

samtranslator/plugins/globals/globals.py

@@ -1,6 +1,7 @@
-from typing import Any, Dict, List
+import copy
+from typing import Any, Dict, List, Optional, Union
 
-from samtranslator.model.exceptions import ExceptionWithMessage
+from samtranslator.model.exceptions import ExceptionWithMessage, InvalidResourceAttributeTypeException
 from samtranslator.public.intrinsics import is_intrinsics
 from samtranslator.public.sdk.resource import SamResourceType
 from samtranslator.swagger.swagger import SwaggerEditor
@@ -99,7 +100,7 @@ class Globals:
         SamResourceType.Function.value: ["RuntimeManagementConfig"],
     }
 
-    def __init__(self, template) -> None:  # type: ignore[no-untyped-def]
+    def __init__(self, template: Dict[str, Any]) -> None:
         """
         Constructs an instance of this object
 
@@ -111,12 +112,57 @@ def __init__(self, template) -> None:  # type: ignore[no-untyped-def]
         # Sort the names for stability in list ordering
         self.supported_resource_section_names.sort()
 
-        self.template_globals = {}
+        self.template_globals: Dict[str, GlobalProperties] = {}
 
         if self._KEYWORD in template:
             self.template_globals = self._parse(template[self._KEYWORD])  # type: ignore[no-untyped-call]
 
-    def merge(self, resource_type, resource_properties):  # type: ignore[no-untyped-def]
+    def get_template_globals(
+        self, logical_id: str, resource_type: str, ignore_globals: Optional[Union[str, List[str]]]
+    ) -> "GlobalProperties":
+        """
+        Get template globals but remove globals based on IgnoreGlobals attribute.
+
+        :param string logical_id: LogicalId of the resource
+        :param string resource_type: Type of the resource (Ex: AWS::Serverless::Function)
+        :param dict ignore_globals: IgnoreGlobals resource attribute. It can be either 1) "*" string value
+            or list of string value, each value should be a valid property in Globals section
+        :return dict: processed template globals
+        """
+        if not ignore_globals:
+            return self.template_globals[resource_type]
+
+        if isinstance(ignore_globals, str) and ignore_globals == "*":
+            return GlobalProperties({})
+
+        if isinstance(ignore_globals, list):
+            global_props: GlobalProperties = copy.deepcopy(self.template_globals[resource_type])
+            for key in ignore_globals:
+                if key not in global_props.global_properties:
+                    raise InvalidResourceAttributeTypeException(
+                        logical_id,
+                        "IgnoreGlobals",
+                        None,
+                        f"Resource {logical_id} has invalid resource attribute 'IgnoreGlobals' on item '{key}'.",
+                    )
+                del global_props.global_properties[key]
+            return global_props
+
+        # We raise exception for any non "*" or non-list input
+        raise InvalidResourceAttributeTypeException(
+            logical_id,
+            "IgnoreGlobals",
+            None,
+            f"Resource {logical_id} has invalid resource attribute 'IgnoreGlobals'.",
+        )
+
+    def merge(
+        self,
+        resource_type: str,
+        resource_properties: Dict[str, Any],
+        logical_id: str = "",
+        ignore_globals: Optional[Union[str, List[str]]] = None,
+    ) -> Any:
         """
         Adds global properties to the resource, if necessary. This method is a no-op if there are no global properties
         for this resource type
@@ -130,12 +176,12 @@ def merge(self, resource_type, resource_properties):  # type: ignore[no-untyped-
             # Nothing to do. Return the template unmodified
             return resource_properties
 
-        global_props = self.template_globals[resource_type]
+        global_props = self.get_template_globals(logical_id, str(resource_type), ignore_globals)
 
-        return global_props.merge(resource_properties)
+        return global_props.merge(resource_properties)  # type: ignore[no-untyped-call]
 
     @classmethod
-    def del_section(cls, template):  # type: ignore[no-untyped-def]
+    def del_section(cls, template: Dict[str, Any]) -> None:
         """
         Helper method to delete the Globals section altogether from the template
 

samtranslator/plugins/globals/globals_plugin.py

@@ -1,4 +1,7 @@
+from typing import Any, Dict
+
 from samtranslator.metrics.method_decorator import cw_timer
+from samtranslator.model.exceptions import InvalidResourceAttributeTypeException
 from samtranslator.plugins.globals.globals import Globals, InvalidGlobalsSectionException
 from samtranslator.public.exceptions import InvalidDocumentException
 from samtranslator.public.plugins import BasePlugin
@@ -13,7 +16,7 @@ class GlobalsPlugin(BasePlugin):
     """
 
     @cw_timer(prefix="Plugin-Globals")
-    def on_before_transform_template(self, template_dict):  # type: ignore[no-untyped-def]
+    def on_before_transform_template(self, template_dict: Dict[str, Any]) -> None:
         """
         Hook method that runs before a template gets transformed. In this method, we parse and process Globals section
         from the template (if present).
@@ -28,11 +31,16 @@ def on_before_transform_template(self, template_dict):  # type: ignore[no-untype
         # For each resource in template, try and merge with Globals if necessary
         template = SamTemplate(template_dict)
         for logicalId, resource in template.iterate():
-            resource.properties = global_section.merge(resource.type, resource.properties)  # type: ignore[no-untyped-call]
+            try:
+                resource.properties = global_section.merge(
+                    str(resource.type), resource.properties, logicalId, resource.ignore_globals
+                )
+            except InvalidResourceAttributeTypeException as ex:
+                raise InvalidDocumentException([ex]) from ex
             template.set(logicalId, resource)
 
         # Remove the Globals section from template if necessary
-        Globals.del_section(template_dict)  # type: ignore[no-untyped-call]
+        Globals.del_section(template_dict)
 
         # If there was a global openApiVersion flag, check and convert swagger
         # to the right version

samtranslator/schema/schema.json

@@ -250245,6 +250245,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -253196,6 +253210,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -253497,6 +253525,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -253581,6 +253623,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -254078,7 +254134,8 @@
           "type": "string"
         },
         "PropagateTags": {
-          "title": "Propagatetags",
+          "markdownDescription": "Indicate whether or not to pass tags from the `Tags` property to your [AWS::Serverless::Function](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification-generated-resources-function.html) generated resources\\. Specify `True` to propagate tags in your generated resources\\.  \n*Type*: Boolean  \n*Required*: No  \n*Default*: `False`  \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
+          "title": "PropagateTags",
           "type": "boolean"
         },
         "ProvisionedConcurrencyConfig": {
@@ -254457,7 +254514,8 @@
           "title": "Policies"
         },
         "PropagateTags": {
-          "title": "Propagatetags",
+          "markdownDescription": "Indicate whether or not to pass tags from the `Tags` property to your [AWS::Serverless::Function](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification-generated-resources-function.html) generated resources\\. Specify `True` to propagate tags in your generated resources\\.  \n*Type*: Boolean  \n*Required*: No  \n*Default*: `False`  \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
+          "title": "PropagateTags",
           "type": "boolean"
         },
         "ProvisionedConcurrencyConfig": {
@@ -254586,6 +254644,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -255505,6 +255577,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -255663,6 +255749,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -255757,6 +255857,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },
@@ -256304,6 +256418,20 @@
         "DependsOn": {
           "$ref": "#/definitions/PassThroughProp"
         },
+        "IgnoreGlobals": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ],
+          "title": "Ignoreglobals"
+        },
         "Metadata": {
           "$ref": "#/definitions/PassThroughProp"
         },

samtranslator/sdk/resource.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import Any, Dict
+from typing import Any, Dict, List, Optional, Union
 
 from samtranslator.model.exceptions import InvalidDocumentException, InvalidTemplateException
 from samtranslator.model.types import IS_STR
@@ -27,6 +27,7 @@ def __init__(self, resource_dict: Dict[str, Any]) -> None:
         self.condition = resource_dict.get("Condition", None)
         self.deletion_policy = resource_dict.get("DeletionPolicy", None)
         self.update_replace_policy = resource_dict.get("UpdateReplacePolicy", None)
+        self.ignore_globals: Optional[Union[str, List[str]]] = resource_dict.get("IgnoreGlobals", None)
 
         # Properties is *not* required. Ex: SimpleTable resource has no required properties
         self.properties = resource_dict.get("Properties", {})