feat: add support for Conditions in Serverless API (#742)

Author: keetonian

samtranslator/model/api/api_generator.py

@@ -27,7 +27,8 @@ class ApiGenerator(object):
     def __init__(self, logical_id, cache_cluster_enabled, cache_cluster_size, variables, depends_on,
                  definition_body, definition_uri, name, stage_name, endpoint_configuration=None,
                  method_settings=None, binary_media=None, cors=None, auth=None, access_log_setting=None,
-                 canary_setting=None, tracing_enabled=None):
+                 canary_setting=None, tracing_enabled=None, resource_attributes=None,
+                 passthrough_resource_attributes=None):
         """Constructs an API Generator class that generates API Gateway resources
 
         :param logical_id: Logical id of the SAM API Resource
@@ -42,6 +43,8 @@ def __init__(self, logical_id, cache_cluster_enabled, cache_cluster_size, variab
         :param access_log_setting: Whether to send access logs and where for Stage
         :param canary_setting: Canary Setting for Stage
         :param tracing_enabled: Whether active tracing with X-ray is enabled
+        :param resource_attributes: Resource attributes to add to API resources
+        :param passthrough_resource_attributes: Attributes such as `Condition` that are added to derived resources
         """
         self.logical_id = logical_id
         self.cache_cluster_enabled = cache_cluster_enabled
@@ -60,14 +63,16 @@ def __init__(self, logical_id, cache_cluster_enabled, cache_cluster_size, variab
         self.access_log_setting = access_log_setting
         self.canary_setting = canary_setting
         self.tracing_enabled = tracing_enabled
+        self.resource_attributes = resource_attributes
+        self.passthrough_resource_attributes = passthrough_resource_attributes
 
     def _construct_rest_api(self):
         """Constructs and returns the ApiGateway RestApi.
 
         :returns: the RestApi to which this SAM Api corresponds
         :rtype: model.apigateway.ApiGatewayRestApi
         """
-        rest_api = ApiGatewayRestApi(self.logical_id, depends_on=self.depends_on)
+        rest_api = ApiGatewayRestApi(self.logical_id, depends_on=self.depends_on, attributes=self.resource_attributes)
         rest_api.BinaryMediaTypes = self.binary_media
 
         if self.endpoint_configuration:
@@ -132,7 +137,8 @@ def _construct_deployment(self, rest_api):
         :returns: the Deployment to which this SAM Api corresponds
         :rtype: model.apigateway.ApiGatewayDeployment
         """
-        deployment = ApiGatewayDeployment(self.logical_id + 'Deployment')
+        deployment = ApiGatewayDeployment(self.logical_id + 'Deployment',
+                                          attributes=self.passthrough_resource_attributes)
         deployment.RestApiId = rest_api.get_runtime_attr('rest_api_id')
         deployment.StageName = 'Stage'
 
@@ -150,7 +156,8 @@ def _construct_stage(self, deployment, swagger):
         # This will NOT create duplicates because we allow only ONE stage per API resource
         stage_name_prefix = self.stage_name if isinstance(self.stage_name, string_types) else ""
 
-        stage = ApiGatewayStage(self.logical_id + stage_name_prefix + 'Stage')
+        stage = ApiGatewayStage(self.logical_id + stage_name_prefix + 'Stage',
+                                attributes=self.passthrough_resource_attributes)
         stage.RestApiId = ref(self.logical_id)
         stage.update_deployment_ref(deployment.logical_id)
         stage.StageName = self.stage_name
@@ -294,15 +301,16 @@ def _get_permission(self, authorizer_name, authorizer_lambda_function_arn):
         :returns: the permission resource
         :rtype: model.lambda_.LambdaPermission
         """
-        rest_api = ApiGatewayRestApi(self.logical_id, depends_on=self.depends_on)
+        rest_api = ApiGatewayRestApi(self.logical_id, depends_on=self.depends_on, attributes=self.resource_attributes)
         api_id = rest_api.get_runtime_attr('rest_api_id')
 
         partition = ArnGenerator.get_partition_name()
         resource = '${__ApiId__}/authorizers/*'
         source_arn = fnSub(ArnGenerator.generate_arn(partition=partition, service='execute-api', resource=resource),
                            {"__ApiId__": api_id})
 
-        lambda_permission = LambdaPermission(self.logical_id + authorizer_name + 'AuthorizerPermission')
+        lambda_permission = LambdaPermission(self.logical_id + authorizer_name + 'AuthorizerPermission',
+                                             attributes=self.passthrough_resource_attributes)
         lambda_permission.Action = 'lambda:invokeFunction'
         lambda_permission.FunctionName = authorizer_lambda_function_arn
         lambda_permission.Principal = 'apigateway.amazonaws.com'

samtranslator/model/sam_resources.py

@@ -467,7 +467,9 @@ def to_cloudformation(self, **kwargs):
                                      auth=self.Auth,
                                      access_log_setting=self.AccessLogSetting,
                                      canary_setting=self.CanarySetting,
-                                     tracing_enabled=self.TracingEnabled)
+                                     tracing_enabled=self.TracingEnabled,
+                                     resource_attributes=self.resource_attributes,
+                                     passthrough_resource_attributes=self.get_passthrough_resource_attributes())
 
         rest_api, deployment, stage, permissions = api_generator.to_cloudformation()
 

tests/translator/input/intrinsic_functions.yaml

@@ -14,6 +14,12 @@ Parameters:
     Type: String
     Default: SomeName
 
+Conditions:
+  TrueCondition:
+    Fn::Equals:
+      - true
+      - true
+
 Resources:
   MyFunction:
     Type: 'AWS::Serverless::Function'
@@ -74,6 +80,7 @@ Resources:
 
   ApiWithExplicitS3Uri:
     Type: AWS::Serverless::Api
+    Condition: TrueCondition
     Properties:
       StageName: dev
       DefinitionUri:

tests/translator/output/aws-cn/intrinsic_functions.json

@@ -16,7 +16,15 @@
       "Default": "PassThrough", 
       "Type": "String"
     }
-  }, 
+  },
+  "Conditions": {
+    "TrueCondition": {
+      "Fn::Equals": [
+        true,
+        true
+      ]
+    }
+  },
   "Resources": {
     "MyFunction": {
       "Type": "AWS::Lambda::Function", 
@@ -105,6 +113,7 @@
     }, 
     "ApiWithExplicitS3UridevStage": {
       "Type": "AWS::ApiGateway::Stage", 
+      "Condition": "TrueCondition",
       "Properties": {
         "DeploymentId": {
           "Ref": "ApiWithExplicitS3UriDeploymenta227798f00"
@@ -193,6 +202,7 @@
     }, 
     "ApiWithExplicitS3UriDeploymenta227798f00": {
       "Type": "AWS::ApiGateway::Deployment", 
+      "Condition": "TrueCondition",
       "Properties": {
         "RestApiId": {
           "Ref": "ApiWithExplicitS3Uri"
@@ -360,6 +370,7 @@
     }, 
     "ApiWithExplicitS3Uri": {
       "Type": "AWS::ApiGateway::RestApi", 
+      "Condition": "TrueCondition",
       "Properties": {
         "EndpointConfiguration": {
           "Types": [

tests/translator/output/aws-us-gov/intrinsic_functions.json

@@ -16,7 +16,15 @@
       "Default": "PassThrough", 
       "Type": "String"
     }
-  }, 
+  },
+  "Conditions": {
+    "TrueCondition": {
+      "Fn::Equals": [
+        true,
+        true
+      ]
+    }
+  },
   "Resources": {
     "MyFunction": {
       "Type": "AWS::Lambda::Function", 
@@ -105,6 +113,7 @@
     }, 
     "ApiWithExplicitS3UridevStage": {
       "Type": "AWS::ApiGateway::Stage", 
+      "Condition": "TrueCondition",
       "Properties": {
         "DeploymentId": {
           "Ref": "ApiWithExplicitS3UriDeploymenta227798f00"
@@ -193,6 +202,7 @@
     }, 
     "ApiWithExplicitS3UriDeploymenta227798f00": {
       "Type": "AWS::ApiGateway::Deployment", 
+      "Condition": "TrueCondition",
       "Properties": {
         "RestApiId": {
           "Ref": "ApiWithExplicitS3Uri"
@@ -360,6 +370,7 @@
     }, 
     "ApiWithExplicitS3Uri": {
       "Type": "AWS::ApiGateway::RestApi", 
+      "Condition": "TrueCondition",
       "Properties": {
         "EndpointConfiguration": {
           "Types": [

tests/translator/output/intrinsic_functions.json

@@ -16,7 +16,15 @@
       "Default": "PassThrough", 
       "Type": "String"
     }
-  }, 
+  },
+  "Conditions": {
+    "TrueCondition": {
+      "Fn::Equals": [
+        true,
+        true
+      ]
+    }
+  },
   "Resources": {
     "MyFunction": {
       "Type": "AWS::Lambda::Function", 
@@ -104,7 +112,8 @@
       }
     }, 
     "ApiWithExplicitS3UridevStage": {
-      "Type": "AWS::ApiGateway::Stage", 
+      "Type": "AWS::ApiGateway::Stage",
+      "Condition": "TrueCondition",
       "Properties": {
         "DeploymentId": {
           "Ref": "ApiWithExplicitS3UriDeploymenta227798f00"
@@ -185,6 +194,7 @@
     }, 
     "ApiWithExplicitS3UriDeploymenta227798f00": {
       "Type": "AWS::ApiGateway::Deployment", 
+      "Condition": "TrueCondition",
       "Properties": {
         "RestApiId": {
           "Ref": "ApiWithExplicitS3Uri"
@@ -351,7 +361,8 @@
       }
     }, 
     "ApiWithExplicitS3Uri": {
-      "Type": "AWS::ApiGateway::RestApi", 
+      "Type": "AWS::ApiGateway::RestApi",
+      "Condition": "TrueCondition",
       "Properties": {
         "BodyS3Location": {
           "Version": "myversion",