aws-cdk-constructs 2.26.3__tar.gz → 2.27.0__tar.gz

{aws_cdk_constructs-2.26.3 → aws_cdk_constructs-2.27.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws_cdk_constructs
-Version: 2.26.3
+Version: 2.27.0
 Summary: AWS CDK constructs
 Home-page: https://bitbucket.org/cioapps/aws-cdk-constructs
 Author: author

{aws_cdk_constructs-2.26.3 → aws_cdk_constructs-2.27.0}/aws_cdk_constructs/__init__.py

@@ -7,11 +7,11 @@ from .bucket import Bucket
 from .ecs.cluster import ECSCluster
 from .ecs.microservice import ECSMicroservice
 from .efs.volume import EFSVolume
-from .api import API
+from .api import Api
 from .service_user_for_iac import ServiceUserForIAC
 from .service_user_for_static_assets import ServiceUserForStaticAssets
 from .load_balancer import Alb, Nlb
 from .security_group import SecurityGroup
 from .windows_server import WindowsServer
 
-__version__ = '2.26.3'
+__version__ = '2.27.0'

aws_cdk_constructs-2.27.0/aws_cdk_constructs/api/__init__.py

@@ -0,0 +1 @@
+from .api import Api

{aws_cdk_constructs-2.26.3 → aws_cdk_constructs-2.27.0}/aws_cdk_constructs/api/api.py

@@ -6,12 +6,46 @@ from aws_cdk_constructs.utils import (
     normalize_environment_parameter,
     get_version,
 )
+from typing import Union
 
 
-class API(Construct):
+class Api(Construct):
+    @property
+    def api(
+        self,
+    ) -> _apigateway.SpecRestApi:
+        """Returns the API Gateway construct
+
+        Returns:
+            _apigateway.SpecRestApi: API Gateway construct
+        """
+        return self._api
+
+    @property
+    def key(
+        self,
+    ) -> _apigateway.ApiKey:
+        """Returns the API Gateway key
+
+        bReturns:
+            _apigateway.ApiKey: API Gateway key
+        """
+        return self._key
+
+    @property
+    def usage_plan(
+        self,
+    ) -> _apigateway.UsagePlan:
+        """Returns the API Gateway usage plan associated to the key
+
+        bReturns:
+            _apigateway.UsagePlan: Returns the API Gateway usage plan associated to the key
+        """
+        return self._usage_plan
+
     """
 
-    The FAO CDK API Construct creates an AWS API Gateway REST API, providing a Swagger JSON file.
+    The FAO CDK Api Construct creates an AWS Api Gateway REST Api, providing a Swagger JSON file.
 
     Every resource created by the construct will be tagged according to the FAO AWS tagging strategy described at https://aws.fao.org
 
@@ -25,7 +59,7 @@ class API(Construct):
 
         environments_parameters (dict): The dictionary containing the references to CSI AWS environments. This will simplify the environment promotions and enable a parametric development of the infrastructures.
 
-        swagger_path (str): The path to the Swagger file (or OpenAPI compatibile) to use to auto-generate API Gateway
+        api_definition_path (str): The path to the OpenAI definition (or compatible) to use to auto-generate Api Gateway
 
     """
 
@@ -36,8 +70,10 @@ class API(Construct):
         app_name: str,
         environment: str,
         environments_parameters: dict,
-        swagger_path: str = None,
-        **kwargs
+        api_definition_path: str,
+        quota: Union[_apigateway.QuotaSettings, None] = None,
+        throttle: Union[_apigateway.ThrottleSettings, None] = None,
+        **kwargs,
     ) -> None:
         super().__init__(scope, id, **kwargs)
         environment = normalize_environment_parameter(environment)
@@ -51,32 +87,28 @@ class API(Construct):
         cdk.Tags.of(cdk.Stack.of(self)).add('fao-cdk-version', get_version())
         cdk.Tags.of(cdk.Stack.of(self)).add('fao-cdk', 'true')
 
-        # Declare variables
-        self.api = None
-
         # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Create conditions
-        swagger_path = swagger_path.strip()
-        swagger_was_provided = swagger_path
+        api_definition_path = api_definition_path.strip()
 
         environment = environment.lower()
         aws_account = environments_parameters['accounts'][environment]
 
-        # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Conditionally create resources
-
-        if swagger_was_provided:
-            # Read the base user data from file
-            with open(swagger_path) as swagger_content:
-                pws_swagger = swagger_content.read()
-            swagger_content.close()
-
-            api = _apigateway.CfnRestApi(
-                self,
-                app_name + '-api',
-                body=None,
-                body_s3_location=_apigateway.CfnRestApi.S3LocationProperty(
-                    bucket=aws_account['s3_config_bucket'],
-                    key=app_name + '/' + environment + '/swagger.json',
-                ),
-                description=app_name + '/' + environment + ' API',
-                name=app_name + '/' + environment,
-            )
+        self._api = _apigateway.SpecRestApi(
+            self,
+            f'{id}-{environment}',
+            api_definition=_apigateway.ApiDefinition.from_asset(
+                api_definition_path
+            ),
+        )
+
+        self._usage_plan = self._api.add_usage_plan(
+            f'{id}-{environment}-usage-plan',
+            name=f'{id}-{environment}-usage-plan',
+            quota=quota,
+            throttle=throttle,
+        )
+
+        self._key = self._api.add_api_key(
+            f'{id}-{environment}-key', api_key_name=f'{id}-{environment}-key'
+        )
+        self._usage_plan.add_api_key(self._key)

{aws_cdk_constructs-2.26.3 → aws_cdk_constructs-2.27.0}/aws_cdk_constructs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-constructs
-Version: 2.26.3
+Version: 2.27.0
 Summary: AWS CDK constructs
 Home-page: https://bitbucket.org/cioapps/aws-cdk-constructs
 Author: author

aws_cdk_constructs-2.26.3/aws_cdk_constructs/api/__init__.py

@@ -1 +0,0 @@
-from .api import API