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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws_cdk_constructs
-Version: 2.26.3
+Version: 2.28.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.28.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.28.0'

aws_cdk_constructs-2.28.0/aws_cdk_constructs/api/__init__.py

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

aws_cdk_constructs-2.28.0/aws_cdk_constructs/api/api.py

@@ -0,0 +1,131 @@
+import aws_cdk as cdk
+from constructs import Construct
+from aws_cdk import aws_apigateway as _apigateway
+
+from aws_cdk_constructs.utils import (
+    normalize_environment_parameter,
+    get_version,
+)
+from typing import Union
+
+
+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.
+
+    Every resource created by the construct will be tagged according to the FAO AWS tagging strategy described at https://aws.fao.org
+
+    Args:
+
+        id (str): the logical id of the newly created resource
+
+        app_name (str): The application name. This will be used to generate the 'ApplicationName' tag for CSI compliancy. The ID of the application. This must be unique for each system, as it will be used to calculate the AWS costs of the system
+
+        environment (str): Specify the environment in which you want to deploy you system. Allowed values: Development, QA, Production, SharedServices
+
+        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.
+
+        api_definition_path (str): The path to the OpenAI definition (or compatible) to use to auto-generate Api Gateway
+
+    """
+
+    def __init__(
+        self,
+        scope: Construct,
+        id: str,
+        app_name: str,
+        environment: str,
+        environments_parameters: dict,
+        api_definition_path: str,
+        quota: Union[_apigateway.QuotaSettings, None] = None,
+        throttle: Union[_apigateway.ThrottleSettings, None] = None,
+        stage_options: Union[_apigateway.StageOptions, None] = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(scope, id, **kwargs)
+        environment = normalize_environment_parameter(environment)
+
+        # Apply mandatory tags
+        cdk.Tags.of(self).add('ApplicationName', app_name.lower().strip())
+        cdk.Tags.of(self).add('Environment', environment)
+
+        # Apply FAO CDK tags
+        cdk.Tags.of(self).add('fao-cdk-construct', 'api')
+        cdk.Tags.of(cdk.Stack.of(self)).add('fao-cdk-version', get_version())
+        cdk.Tags.of(cdk.Stack.of(self)).add('fao-cdk', 'true')
+
+        # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Create conditions
+        api_definition_path = api_definition_path.strip()
+
+        environment_lower = environment.lower()
+        aws_account = environments_parameters['accounts'][environment_lower]
+
+        self._api = _apigateway.SpecRestApi(
+            self,
+            f'{id}-{environment_lower}',
+            api_definition=_apigateway.ApiDefinition.from_asset(
+                api_definition_path
+            ),
+            deploy_options=(
+                stage_options
+                if stage_options
+                else _apigateway.StageOptions(
+                    cache_data_encrypted=False,
+                    caching_enabled=False,
+                    data_trace_enabled=False,
+                    description=f'[{app_name}] {id} {environment_lower}',
+                    stage_name=environment_lower,
+                )
+            ),
+        )
+
+        self._usage_plan = self._api.add_usage_plan(
+            f'{id}-{environment_lower}-usage-plan',
+            name=f'{id}-{environment_lower}-usage-plan',
+            quota=quota,
+            throttle=throttle,
+        )
+
+        self._usage_plan.add_api_stage(
+            stage=self._api.deployment_stage,
+        )
+
+        self._key = self._api.add_api_key(
+            f'{id}-{environment_lower}-key',
+            api_key_name=f'{id}-{environment_lower}-key',
+        )
+        self._usage_plan.add_api_key(self._key)

{aws_cdk_constructs-2.26.3 → aws_cdk_constructs-2.28.0}/aws_cdk_constructs/bucket/bucket.py

@@ -107,13 +107,25 @@ class Bucket(Construct):
     """
 
     @property
-    def get_s3_bucket(self) -> aws_cdk.aws_s3.Bucket:
+    def bucket(self) -> aws_cdk.aws_s3.Bucket:
+        """DEPRECATED: Returns the S3 bucket
+
+        Returns:
+            aws_s3.Bucket: the S3 bucket
+        """
+        return self._bucket
+
+    @property
+    def get_s3_bucket(self):
         """Returns the S3 bucket
 
         Returns:
             aws_s3.Bucket: the S3 bucket
         """
-        return self.bucket
+
+        raise DeprecationWarning(
+            'This is a deprecated method, please do not use it. use Bucket.bucket attribute instead.'
+        )
 
     @property
     def cloudfront_distribution(
@@ -146,12 +158,61 @@ class Bucket(Construct):
             'This is a deprecated method, please do not use it. Instantiate a new FAI CDK Bucket construct instead.'
         )
 
+    def update_distribution_origin_access(self):
+        ## clean-up the OAI reference and associate the OAC with the cloudfront distribution
+        # query the site bucket policy as a document
+        bucket_policy = self.bucket.policy
+        bucket_policy_document = bucket_policy.document
+
+        # remove the CloudFront Origin Access Identity permission from the bucket policy
+        if isinstance(bucket_policy_document, _iam.PolicyDocument):
+            bucket_policy_document_json = bucket_policy_document.to_json()
+            # create an updated policy without the OAI reference
+            bucket_policy_updated_json = {
+                'Version': '2012-10-17',
+                'Statement': [],
+            }
+            for statement in bucket_policy_document_json['Statement']:
+                if 'CanonicalUser' not in statement['Principal']:
+                    bucket_policy_updated_json['Statement'].append(statement)
+
+        # apply the updated bucket policy to the bucket
+        bucket_policy_override = self.bucket.node.find_child(
+            'Policy'
+        ).node.default_child
+        bucket_policy_override.add_override(
+            'Properties.PolicyDocument', bucket_policy_updated_json
+        )
+
+        # remove the created OAI reference (S3 Origin property) for the distribution
+        all_distribution_props = self._cloudfront_distribution.node.find_all()
+        for child in all_distribution_props:
+            if child.node.id == 'S3Origin':
+                child.node.try_remove_child('Resource')
+
+        # associate the created OAC with the distribution
+        distribution_props = self._cloudfront_distribution.node.default_child
+
+        # The amount of the distribution origins is equal to the number of direct CDK object
+        # of the distribution construct - 1 (the Resource object)
+        origins_amount = len(self._cloudfront_distribution.node.children) - 1
+
+        for index in range(0, origins_amount):
+            distribution_props.add_override(
+                f'Properties.DistributionConfig.Origins.{index}.S3OriginConfig.OriginAccessIdentity',
+                '',
+            )
+            distribution_props.add_property_override(
+                f'DistributionConfig.Origins.{index}.OriginAccessControlId',
+                self._origin_access_control.ref,
+            )
+
     def _create_bucket(
         self,
         logic_id: str,
         bucket_name: str,
         app_name: str,
-        access_control: aws_cdk.aws_s3.BucketAccessControl = None,
+        access_control: Union[aws_cdk.aws_s3.BucketAccessControl, None] = None,
         public_read_access: bool = False,
         website_index_document: str = None,
         website_error_document: str = None,
@@ -363,71 +424,6 @@ class Bucket(Construct):
             for statement in bucket_policy_statements:
                 s3_bucket.add_to_resource_policy(statement)
 
-            ## clean-up the OAI reference and associate the OAC with the cloudfront distribution
-            # query the site bucket policy as a document
-            bucket_policy = s3_bucket.policy
-            bucket_policy_document = bucket_policy.document
-
-            # remove the CloudFront Origin Access Identity permission from the bucket policy
-            if isinstance(bucket_policy_document, _iam.PolicyDocument):
-                bucket_policy_document_json = bucket_policy_document.to_json()
-                # create an updated policy without the OAI reference
-                bucket_policy_updated_json = {
-                    'Version': '2012-10-17',
-                    'Statement': [],
-                }
-                for statement in bucket_policy_document_json['Statement']:
-                    if 'CanonicalUser' not in statement['Principal']:
-                        bucket_policy_updated_json['Statement'].append(
-                            statement
-                        )
-
-            # apply the updated bucket policy to the bucket
-            bucket_policy_override = s3_bucket.node.find_child(
-                'Policy'
-            ).node.default_child
-            bucket_policy_override.add_override(
-                'Properties.PolicyDocument', bucket_policy_updated_json
-            )
-
-            # remove the created OAI reference (S3 Origin property) for the distribution
-            all_distribution_props = (
-                self._cloudfront_distribution.node.find_all()
-            )
-            for child in all_distribution_props:
-                if child.node.id == 'S3Origin':
-                    child.node.try_remove_child('Resource')
-
-            # associate the created OAC with the distribution
-            distribution_props = (
-                self._cloudfront_distribution.node.default_child
-            )
-            distribution_props.add_override(
-                'Properties.DistributionConfig.Origins.0.S3OriginConfig.OriginAccessIdentity',
-                '',
-            )
-            distribution_props.add_property_override(
-                'DistributionConfig.Origins.0.OriginAccessControlId',
-                self._origin_access_control.ref,
-            )
-
-            # Assign Origin Access Control
-            # indexes = ["0"]
-            # for index in indexes:
-            #     self._cloudfront_distribution.node.find_child(
-            #         "Resource"
-            #     ).add_property_override(
-            #         f"DistributionConfig.Origins.{index}.OriginAccessControlId",
-            #         self._origin_access_control.get_att("Id"),
-            #     )
-
-            #     self._cloudfront_distribution.node.find_child(
-            #         "Resource"
-            #     ).add_property_override(
-            #         f"DistributionConfig.Origins.{index}.S3OriginConfig.OriginAccessIdentity",
-            #         {},
-            #     )
-
         return s3_bucket
 
     def __init__(
@@ -471,18 +467,12 @@ class Bucket(Construct):
         cdk.Tags.of(cdk.Stack.of(self)).add('fao-cdk', 'true')
 
         # Declare variables
-        self.bucket = None
-
         environment = environment.lower()
         self.environment = environment
         self.aws_account = environments_parameters['accounts'][environment]
         logic_id = bucket_logic_id if bucket_logic_id else 'S3'
 
         # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Create conditions
-        # bucket_name_was_provided = bucket_name.strip()
-        # bucket_already_exist = check_if_bucket_exist(
-        #     s3_bucket_name=bucket_name
-        # )
 
         # Check if bucket has to be public
         public_read_access = (
@@ -558,7 +548,7 @@ class Bucket(Construct):
             removal_policy = cdk.RemovalPolicy.RETAIN
 
         # Default access level: PRIVATE
-        self.bucket = self._create_bucket(
+        self._bucket = self._create_bucket(
             logic_id=logic_id,
             app_name=app_name,
             bucket_name=bucket_name,
@@ -596,7 +586,7 @@ class Bucket(Construct):
             public_read_access = False
             bucket_has_cdn = False
 
-            self.bucket.add_to_resource_policy(
+            self._bucket.add_to_resource_policy(
                 _iam.PolicyStatement(
                     principals=[_iam.AnyPrincipal()],
                     actions=['s3:GetObject'],
@@ -614,17 +604,17 @@ class Bucket(Construct):
 
         if public_read_access:
             # Grant access to anyone
-            self.bucket.grant_public_access()
+            self._bucket.grant_public_access()
 
             # Temporary fix for:
             # https://github.com/aws/aws-cdk/issues/25358
-            s3_resource = self.bucket.node.default_child
+            s3_resource = self._bucket.node.default_child
             s3_resource.add_override(
                 'Properties.PublicAccessBlockConfiguration.BlockPublicPolicy',
                 'False',
             )
 
-            self.bucket.add_cors_rule(
+            self._bucket.add_cors_rule(
                 allowed_methods=[
                     _s3.HttpMethods.GET,
                     _s3.HttpMethods.POST,
@@ -665,7 +655,7 @@ class Bucket(Construct):
             ]
 
             # Only allow access from Cloudflare IPs
-            self.bucket.add_to_resource_policy(
+            self._bucket.add_to_resource_policy(
                 _iam.PolicyStatement(
                     effect=_iam.Effect.DENY,
                     principals=[_iam.AnyPrincipal()],
@@ -678,7 +668,7 @@ class Bucket(Construct):
                     },
                 )
             )
-            self.bucket.add_to_resource_policy(
+            self._bucket.add_to_resource_policy(
                 _iam.PolicyStatement(
                     effect=_iam.Effect.ALLOW,
                     principals=[_iam.AnyPrincipal()],
@@ -695,7 +685,7 @@ class Bucket(Construct):
             # If the CORS configuration is applied twice the following error will be raised
             # "Properties validation failed for resource XYZBucket with message: #/CorsConfiguration/CorsRules: array items are not unique"
             if not public_read_access:
-                self.bucket.add_cors_rule(
+                self._bucket.add_cors_rule(
                     allowed_methods=[
                         _s3.HttpMethods.GET,
                         _s3.HttpMethods.POST,
@@ -729,7 +719,7 @@ class Bucket(Construct):
                 self,
                 'Distribution',
                 authorization=authorization,
-                origin=origins.S3Origin(self.bucket),
+                origin=origins.S3Origin(self._bucket),
                 domain_names=[bucket_name],
             )
 

{aws_cdk_constructs-2.26.3 → aws_cdk_constructs-2.28.0}/aws_cdk_constructs/microservice/microservice.py

@@ -485,6 +485,7 @@ class Microservice(Construct):
         network_load_balancer_source_autoscaling_group: aws_cdk.aws_autoscaling.AutoScalingGroup = None,
         stickiness_cookie_duration_in_hours: str = None,
         load_balancer_idle_timeout_in_seconds: str = None,
+        load_balancer_name_postfix: str = '',
         rubrik_backup: str = 'True',
         efs_backup: str = 'True',
         dns_record: str = None,
@@ -784,7 +785,15 @@ class Microservice(Construct):
                 network_load_balancer_subnet_2=network_load_balancer_subnet_2,
                 ec2_traffic_port=ec2_traffic_port,
                 load_balancer_name='-'.join(
-                    [app_name, main_component_name, 'nlb']
+                    filter(
+                        None,
+                        [
+                            app_name,
+                            main_component_name,
+                            'nlb',
+                            load_balancer_name_postfix,
+                        ],
+                    )
                 ),
                 dns_record=dns_record,
                 create_dns=create_dns,
@@ -801,7 +810,15 @@ class Microservice(Construct):
                 environments_parameters=environments_parameters,
                 internet_facing=is_public,
                 load_balancer_name='-'.join(
-                    [app_name, main_component_name, 'alb']
+                    filter(
+                        None,
+                        [
+                            app_name,
+                            main_component_name,
+                            'alb',
+                            load_balancer_name_postfix,
+                        ],
+                    )
                 ),
                 use_cdn=use_cdn,
                 will_implement_cdn=will_implement_cdn,
@@ -826,9 +843,8 @@ class Microservice(Construct):
                 client_secret=client_secret,
                 user_info_endpoint=user_info_endpoint,
                 upstream_security_group=upstream_security_group,
-                allow_ingress_from_everyone=True
-                if allow_ingress_from_everyone.lower() == 'true'
-                else False,
+                allow_ingress_from_everyone=allow_ingress_from_everyone.lower()
+                == 'true',
             )
             self.alb = alb.alb
             self.alb_construct = alb

{aws_cdk_constructs-2.26.3 → aws_cdk_constructs-2.28.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.28.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

aws_cdk_constructs-2.26.3/aws_cdk_constructs/api/api.py

@@ -1,82 +0,0 @@
-import aws_cdk as cdk
-from constructs import Construct
-from aws_cdk import aws_apigateway as _apigateway
-
-from aws_cdk_constructs.utils import (
-    normalize_environment_parameter,
-    get_version,
-)
-
-
-class API(Construct):
-    """
-
-    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
-
-    Args:
-
-        id (str): the logical id of the newly created resource
-
-        app_name (str): The application name. This will be used to generate the 'ApplicationName' tag for CSI compliancy. The ID of the application. This must be unique for each system, as it will be used to calculate the AWS costs of the system
-
-        environment (str): Specify the environment in which you want to deploy you system. Allowed values: Development, QA, Production, SharedServices
-
-        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
-
-    """
-
-    def __init__(
-        self,
-        scope: Construct,
-        id: str,
-        app_name: str,
-        environment: str,
-        environments_parameters: dict,
-        swagger_path: str = None,
-        **kwargs
-    ) -> None:
-        super().__init__(scope, id, **kwargs)
-        environment = normalize_environment_parameter(environment)
-
-        # Apply mandatory tags
-        cdk.Tags.of(self).add('ApplicationName', app_name.lower().strip())
-        cdk.Tags.of(self).add('Environment', environment)
-
-        # Apply FAO CDK tags
-        cdk.Tags.of(self).add('fao-cdk-construct', 'api')
-        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
-
-        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,
-            )