fix: Truncate Event Bridge Rule if Id is over 64 characters (#2967)

Author: GavinZZ

samtranslator/model/events.py

@@ -1,6 +1,13 @@
+from typing import Any, Dict, List, Optional
+
 from samtranslator.model import GeneratedProperty, Resource
 from samtranslator.model.intrinsics import fnGetAtt, ref
 
+# Event Rule Targets Id and Logical Id has maximum 64 characters limit
+# https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_Target.html
+EVENT_RULE_LOGICAL_ID_MAX_LENGTH = 64
+EVENT_RULE_LOGICAL_ID_EVENT_SUFFIX = "Event"
+
 
 class EventsRule(Resource):
     resource_type = "AWS::Events::Rule"
@@ -16,3 +23,33 @@ class EventsRule(Resource):
     }
 
     runtime_attrs = {"rule_id": lambda self: ref(self.logical_id), "arn": lambda self: fnGetAtt(self.logical_id, "Arn")}
+
+    def __init__(
+        self,
+        logical_id: Optional[Any],
+        relative_id: Optional[str] = None,
+        depends_on: Optional[List[str]] = None,
+        attributes: Optional[Dict[str, Any]] = None,
+    ) -> None:
+        super().__init__(logical_id, relative_id, depends_on, attributes)
+
+        if len(self.logical_id) > EVENT_RULE_LOGICAL_ID_MAX_LENGTH:
+            # Truncate logical id to satisfy the EVENT_RULE_ID_MAX_LENGTH limit
+            self.logical_id = _truncate_with_suffix(
+                self.logical_id, EVENT_RULE_LOGICAL_ID_MAX_LENGTH, EVENT_RULE_LOGICAL_ID_EVENT_SUFFIX
+            )
+
+
+def generate_valid_target_id(logical_id: str, suffix: str) -> str:
+    """Truncate Target Id if it is exceeding EVENT_RULE_ID_MAX_LENGTH limi."""
+    if len(logical_id) + len(suffix) <= EVENT_RULE_LOGICAL_ID_MAX_LENGTH:
+        return logical_id + suffix
+
+    return _truncate_with_suffix(logical_id, EVENT_RULE_LOGICAL_ID_MAX_LENGTH, suffix)
+
+
+def _truncate_with_suffix(s: str, length: int, suffix: str) -> str:
+    """
+    Truncate string if input string + suffix exceeds length requirement
+    """
+    return s[: length - len(suffix)] + suffix

samtranslator/model/eventsources/push.py

@@ -8,7 +8,7 @@
 from samtranslator.model import PropertyType, ResourceMacro
 from samtranslator.model.cognito import CognitoUserPool
 from samtranslator.model.eventbridge_utils import EventBridgeRuleUtils
-from samtranslator.model.events import EventsRule
+from samtranslator.model.events import EventsRule, generate_valid_target_id
 from samtranslator.model.eventsources import FUNCTION_EVETSOURCE_METRIC_PREFIX
 from samtranslator.model.eventsources.pull import SQS
 from samtranslator.model.exceptions import InvalidDocumentException, InvalidEventException, InvalidResourceException
@@ -31,6 +31,7 @@
 CONDITION = "Condition"
 
 REQUEST_PARAMETER_PROPERTIES = ["Required", "Caching"]
+EVENT_RULE_LAMBDA_TARGET_SUFFIX = "LambdaTarget"
 
 
 class PushEventSource(ResourceMacro, metaclass=ABCMeta):
@@ -176,7 +177,8 @@ def _construct_target(self, function, dead_letter_queue_arn=None):  # type: igno
         :returns: the Target property
         :rtype: dict
         """
-        target = {"Arn": function.get_runtime_attr("arn"), "Id": self.logical_id + "LambdaTarget"}
+        target_id = generate_valid_target_id(self.logical_id, EVENT_RULE_LAMBDA_TARGET_SUFFIX)
+        target = {"Arn": function.get_runtime_attr("arn"), "Id": target_id}
         if self.Input is not None:
             target["Input"] = self.Input
 
@@ -271,7 +273,11 @@ def _construct_target(self, function, dead_letter_queue_arn=None):  # type: igno
         :returns: the Target property
         :rtype: dict
         """
-        target_id = self.Target["Id"] if self.Target and "Id" in self.Target else self.logical_id + "LambdaTarget"
+        target_id = (
+            self.Target["Id"]
+            if self.Target and "Id" in self.Target
+            else generate_valid_target_id(self.logical_id, EVENT_RULE_LAMBDA_TARGET_SUFFIX)
+        )
         target = {"Arn": function.get_runtime_attr("arn"), "Id": target_id}
         if self.Input is not None:
             target["Input"] = self.Input

samtranslator/model/stepfunctions/events.py

@@ -5,7 +5,7 @@
 from samtranslator.metrics.method_decorator import cw_timer
 from samtranslator.model import Property, PropertyType, Resource, ResourceMacro
 from samtranslator.model.eventbridge_utils import EventBridgeRuleUtils
-from samtranslator.model.events import EventsRule
+from samtranslator.model.events import EventsRule, generate_valid_target_id
 from samtranslator.model.eventsources.push import Api as PushApi
 from samtranslator.model.exceptions import InvalidEventException
 from samtranslator.model.iam import IAMRole, IAMRolePolicies
@@ -16,6 +16,7 @@
 
 CONDITION = "Condition"
 SFN_EVETSOURCE_METRIC_PREFIX = "SFNEventSource"
+EVENT_RULE_SFN_TARGET_SUFFIX = "StepFunctionsTarget"
 
 
 class EventSource(ResourceMacro, metaclass=ABCMeta):
@@ -156,7 +157,9 @@ def _construct_target(self, resource, role, dead_letter_queue_arn=None):  # type
         :rtype: dict
         """
         target_id = (
-            self.Target["Id"] if self.Target and "Id" in self.Target else self.logical_id + "StepFunctionsTarget"
+            self.Target["Id"]
+            if self.Target and "Id" in self.Target
+            else generate_valid_target_id(self.logical_id, EVENT_RULE_SFN_TARGET_SUFFIX)
         )
         target = {
             "Arn": resource.get_runtime_attr("arn"),
@@ -249,7 +252,9 @@ def _construct_target(self, resource, role, dead_letter_queue_arn=None):  # type
         :rtype: dict
         """
         target_id = (
-            self.Target["Id"] if self.Target and "Id" in self.Target else self.logical_id + "StepFunctionsTarget"
+            self.Target["Id"]
+            if self.Target and "Id" in self.Target
+            else generate_valid_target_id(self.logical_id, EVENT_RULE_SFN_TARGET_SUFFIX)
         )
         target = {
             "Arn": resource.get_runtime_attr("arn"),

tests/translator/input/event_bridge_rule_super_long_id.yaml

@@ -0,0 +1,43 @@
+Transform: AWS::Serverless-2016-10-31
+
+Resources:
+  QueryForAvailabilityWithUserExceptionQueryForAvailabilityWithUserException:
+    Type: AWS::Serverless::Function
+    Properties:
+      Handler: index.handler
+      Runtime: nodejs14.x
+      InlineCode: |
+        exports.handler = async (event, context, callback) => {
+          return {
+            statusCode: 200,
+            body: 'Success'
+          }
+        }
+      Events:
+        QueryForAvailabilityWithUserExceptionEvent:
+          Type: Schedule
+          Properties:
+            Schedule: cron(05 12 * * ? *)
+
+  SuperSuperSuperSuperLongNameForStepFunction:
+    Type: AWS::Serverless::StateMachine
+    Properties:
+      Name: MyStateMachine
+      Events:
+        SuperSuperSuperSuperLongNameForStepFunctionCWEventEvent:
+          Type: CloudWatchEvent
+          Properties:
+            Pattern:
+              detail:
+                state:
+                - terminated
+        MyApiEvent:
+          Type: Api
+          Properties:
+            Path: /startMyExecution
+            Method: post
+      DefinitionUri:
+        Bucket: sam-demo-bucket
+        Key: my-state-machine.asl.json
+        Version: 3
+      Role: !Sub 'arn:${AWS::Partition}:iam::123456123456:role/service-role/SampleRole'