aws-cdk-constructs 2.48.0__tar.gz → 2.49.0__tar.gz

{aws_cdk_constructs-2.48.0/aws_cdk_constructs.egg-info → aws_cdk_constructs-2.49.0}/PKG-INFO

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

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0}/aws_cdk_constructs/__init__.py

@@ -15,4 +15,4 @@ from .load_balancer import Alb, Nlb
 from .security_group import SecurityGroup
 from .windows_server import WindowsServer
 
-__version__ = '2.48.0'
+__version__ = '2.49.0'

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0}/aws_cdk_constructs/ecs/cluster.py

@@ -87,6 +87,8 @@ class ECSCluster(Construct):
             ec2_send_emails (Optional - bool): When set to true, attaches the SMTP relay security group (defined by ``smtp_relay_security_group`` in the environment account parameters) to the EC2 launch template, allowing instances to send emails through the relay. Default is false.
 
             will_drop_invalid_headers (Optional | str): Indicates whether HTTP headers with invalid header fields are removed by the load balancer ('true') or routed to targets ('false'). Default: false
+
+            container_insights (Optional | str): Whether to enable Container Insights for the cluster. This can be 'DISABLED', 'ENABLED' or 'ENHANCED'. Default: ENABLED
     """
 
     def __init__(
@@ -115,6 +117,7 @@ class ECSCluster(Construct):
         ec2_tag_scheduler_uptime_days: Optional[str] = '1-2-3-4-5',
         ec2_tag_scheduler_skip: Optional[str] = 'False',
         will_drop_invalid_headers: str = 'False',
+        container_insights: Optional[str] = 'ENABLED',
     ) -> None:
         self.id = id
         self.scope = scope
@@ -145,6 +148,7 @@ class ECSCluster(Construct):
         self.ec2_instance_type = (ec2_instance_type,)
         self.ec2_max_capacity = (ec2_max_capacity,)
         self.ec2_desired_capacity = ec2_desired_capacity
+        self.container_insights = container_insights
 
         super().__init__(scope, id)
 
@@ -351,11 +355,18 @@ class ECSCluster(Construct):
         )
 
     def _create_cluster(self) -> None:
+        if self.container_insights == 'ENHANCED':
+            self.config_insights = _ecs.ContainerInsights.ENHANCED
+        elif self.container_insights == 'DISABLED':
+            self.config_insights = _ecs.ContainerInsights.DISABLED
+        else:
+            self.config_insights = _ecs.ContainerInsights.ENABLED
+
         self.cluster = _ecs.Cluster(
             scope=self.scope,
             id=self.id + '_ecs',
             vpc=self.vpc,
-            container_insights=True,
+            container_insights_v2=self.config_insights,
         )
 
     def register_ms(self, microservice: ECSMicroservice) -> None:

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0}/aws_cdk_constructs/ecs/microservice.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 from typing import Optional, List, Dict, TYPE_CHECKING
 
+import aws_cdk as cdk
 from aws_cdk import (
     Tags,
     Duration,
@@ -17,6 +18,10 @@ from aws_cdk import (
     aws_cloudwatch as _cloudwatch,
 )
 from constructs import Construct
+from aws_cdk_constructs.utils import (
+    normalize_environment_parameter,
+    get_version,
+)
 
 from aws_cdk_constructs.ecs.fargate_validator import FargateValidator
 from aws_cdk_constructs.efs.volume import EFSVolume
@@ -212,6 +217,17 @@ class ECSMicroservice(Construct):
         self.main_container = self._create_main_container()
         self.service = self._create_service()
 
+        # Apply mandatory tags
+        tag_environment = normalize_environment_parameter(self.environment)
+        tag_app_name = self.cluster.app_name.lower().strip()
+
+        for entity in [self.task, self.service]:
+            Tags.of(entity).add('ApplicationName', tag_app_name)
+            Tags.of(entity).add('Environment', tag_environment)
+            Tags.of(entity).add('fao-cdk-version', get_version())
+            Tags.of(entity).add('fao-cdk', 'true')
+            Tags.of(entity).add('fao-cdk-construct', 'ecs_microservice')
+
         # It will attach services to the LB listener and route them by hostname
         if self.cluster.alb is not None and internal is False:
             lb_target_priority = self.cluster.alb.get_safe_rule_priority()

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0}/aws_cdk_constructs/efs/volume.py

@@ -11,7 +11,10 @@ from aws_cdk import (
     RemovalPolicy,
     Tags,
 )
-
+from aws_cdk_constructs.utils import (
+    normalize_environment_parameter,
+    get_version,
+)
 from constructs import Construct
 
 
@@ -96,6 +99,16 @@ class EFSVolume(Construct):
             removal_policy=efs_removal_policy,
         )
 
+        # Apply mandatory tags
+        tag_environment = normalize_environment_parameter(self._environment)
+        tag_app_name = self.app_name.lower().strip()
+
+        Tags.of(self.efs).add('ApplicationName', tag_app_name)
+        Tags.of(self.efs).add('Environment', tag_environment)
+        Tags.of(self.efs).add('fao-cdk-version', get_version())
+        Tags.of(self.efs).add('fao-cdk', 'true')
+        Tags.of(self.efs).add('fao-cdk-construct', 'efs_volume')
+
         self._efs_security_group = self.efs.node.find_child('EfsSecurityGroup')
 
         if to_be_backed_up:

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0/aws_cdk_constructs.egg-info}/PKG-INFO

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

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0}/tests/test_ecs_cluster.py

@@ -805,3 +805,46 @@ def test_ecs_with_ec2_creates_asg(
             ],
         },
     )
+
+
+@pytest.mark.parametrize(
+    'insights_input, expected_value',
+    [
+        ('ENABLED', 'enabled'),
+        ('ENHANCED', 'enhanced'),
+        ('DISABLED', 'disabled'),
+    ],
+)
+def test_ecs_cluster_container_insights_configuration(
+    stack,
+    vpc,
+    hosted_zone,
+    environment_parameters,
+    mocker,
+    insights_input,
+    expected_value,
+):
+    mocker.patch('aws_cdk.aws_ec2.Vpc.from_lookup', return_value=vpc)
+
+    ECSCluster(
+        scope=stack,
+        id='x',
+        environment='development',
+        environments_parameters=environment_parameters,
+        app_name='testapp',
+        hosted_zone=hosted_zone,
+        container_insights=insights_input,
+    )
+    template = Template.from_stack(stack)
+
+    template.has_resource_properties(
+        'AWS::ECS::Cluster',
+        {
+            'ClusterSettings': [
+                {
+                    'Name': 'containerInsights',
+                    'Value': expected_value,
+                }
+            ]
+        },
+    )

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0}/tests/test_ecs_microservice.py

@@ -5,6 +5,7 @@ from aws_cdk.assertions import Template, Match
 from aws_cdk_constructs.ecs.cluster import ECSCluster
 from aws_cdk_constructs.ecs.microservice import ECSMicroservice
 from aws_cdk_constructs.efs.volume import EFSVolume
+from aws_cdk_constructs.utils import get_version
 
 
 @pytest.fixture
@@ -548,6 +549,72 @@ def test_service_has_custom_scheduling_tags(stack, cluster):
     )
 
 
+MANDATORY_TAGS = [
+    {'Key': 'ApplicationName', 'Value': 'test-app'},
+    {'Key': 'Environment', 'Value': 'Development'},
+    {'Key': 'fao-cdk', 'Value': 'true'},
+    {'Key': 'fao-cdk-construct', 'Value': 'ecs_microservice'},
+    {'Key': 'fao-cdk-version', 'Value': get_version()},
+]
+
+
+def test_task_definition_has_mandatory_tags(stack, ms, template):
+    template.has_resource_properties(
+        'AWS::ECS::TaskDefinition',
+        {'Tags': Match.array_with(MANDATORY_TAGS)},
+    )
+
+
+def test_service_has_mandatory_tags(stack, ms, template):
+    template.has_resource_properties(
+        'AWS::ECS::Service',
+        {'Tags': Match.array_with(MANDATORY_TAGS)},
+    )
+
+
+def test_mandatory_tags_normalize_environment(stack, cluster):
+    cluster.environment = 'production'
+    ECSMicroservice(
+        scope=stack, name='test-ms', image='repository/image', cluster=cluster
+    )
+    template = Template.from_stack(stack)
+    for resource_type in ['AWS::ECS::Service', 'AWS::ECS::TaskDefinition']:
+        template.has_resource_properties(
+            resource_type,
+            {
+                'Tags': Match.array_with(
+                    [{'Key': 'Environment', 'Value': 'Production'}]
+                )
+            },
+        )
+
+
+def test_mandatory_tags_normalize_app_name(
+    stack, vpc, environment_parameters, mocker
+):
+    mocker.patch('aws_cdk.aws_ec2.Vpc.from_lookup', return_value=vpc)
+    cluster = ECSCluster(
+        scope=stack,
+        id='x',
+        environments_parameters=environment_parameters,
+        environment='development',
+        app_name='Test-App',
+    )
+    ECSMicroservice(
+        scope=stack, name='test-ms', image='repository/image', cluster=cluster
+    )
+    template = Template.from_stack(stack)
+    for resource_type in ['AWS::ECS::Service', 'AWS::ECS::TaskDefinition']:
+        template.has_resource_properties(
+            resource_type,
+            {
+                'Tags': Match.array_with(
+                    [{'Key': 'ApplicationName', 'Value': 'test-app'}]
+                )
+            },
+        )
+
+
 def test_service_includes_all_alternative_fqdns(
     stack, vpc, environment_parameters, mocker
 ):

{aws_cdk_constructs-2.48.0 → aws_cdk_constructs-2.49.0}/tests/test_efs_volume.py

@@ -1,8 +1,9 @@
 import aws_cdk as cdk
 import pytest
-from aws_cdk.assertions import Template
+from aws_cdk.assertions import Template, Match
 
 from aws_cdk_constructs.efs.volume import EFSVolume
+from aws_cdk_constructs.utils import get_version
 
 
 @pytest.fixture
@@ -53,15 +54,90 @@ def test_created_volume_template(stack, vpc, environment_parameters):
     template.has_resource_properties(
         'AWS::EFS::FileSystem',
         {
-            'FileSystemTags': [
-                {'Key': 'HasBackup', 'Value': 'false'},
-                {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
-            ]
+            'FileSystemTags': Match.array_with(
+                [
+                    {'Key': 'HasBackup', 'Value': 'false'},
+                    {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
+                ]
+            )
         },
     )
     template.resource_count_is('AWS::EFS::MountTarget', 2)
 
 
+MANDATORY_TAGS = [
+    {'Key': 'ApplicationName', 'Value': 'test-app'},
+    {'Key': 'Environment', 'Value': 'Development'},
+    {'Key': 'fao-cdk', 'Value': 'true'},
+    {'Key': 'fao-cdk-construct', 'Value': 'efs_volume'},
+    {'Key': 'fao-cdk-version', 'Value': get_version()},
+]
+
+
+def test_volume_has_mandatory_tags(stack, vpc, environment_parameters):
+    EFSVolume(
+        scope=stack,
+        id='volume-id',
+        environment='development',
+        environments_parameters=environment_parameters,
+        vpc=vpc,
+        volume_mount_path='/opt/mount',
+        app_name='test-app',
+    )
+
+    template = Template.from_stack(stack)
+    template.has_resource_properties(
+        'AWS::EFS::FileSystem',
+        {'FileSystemTags': Match.array_with(MANDATORY_TAGS)},
+    )
+
+
+def test_mandatory_tags_normalize_environment(
+    stack, vpc, environment_parameters
+):
+    EFSVolume(
+        scope=stack,
+        id='volume-id',
+        environment='production',
+        environments_parameters=environment_parameters,
+        vpc=vpc,
+        volume_mount_path='/opt/mount',
+        app_name='test-app',
+    )
+
+    template = Template.from_stack(stack)
+    template.has_resource_properties(
+        'AWS::EFS::FileSystem',
+        {
+            'FileSystemTags': Match.array_with(
+                [{'Key': 'Environment', 'Value': 'Production'}]
+            )
+        },
+    )
+
+
+def test_mandatory_tags_normalize_app_name(stack, vpc, environment_parameters):
+    EFSVolume(
+        scope=stack,
+        id='volume-id',
+        environment='development',
+        environments_parameters=environment_parameters,
+        vpc=vpc,
+        volume_mount_path='/opt/mount',
+        app_name='Test-App',
+    )
+
+    template = Template.from_stack(stack)
+    template.has_resource_properties(
+        'AWS::EFS::FileSystem',
+        {
+            'FileSystemTags': Match.array_with(
+                [{'Key': 'ApplicationName', 'Value': 'test-app'}]
+            )
+        },
+    )
+
+
 def test_grant_access_to_volume(stack, vpc, environment_parameters):
     volume = EFSVolume(
         scope=stack,
@@ -116,10 +192,12 @@ def test_development_policy_and_backup(stack, vpc, environment_parameters):
     template.has_resource_properties(
         'AWS::EFS::FileSystem',
         {
-            'FileSystemTags': [
-                {'Key': 'HasBackup', 'Value': 'false'},
-                {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
-            ]
+            'FileSystemTags': Match.array_with(
+                [
+                    {'Key': 'HasBackup', 'Value': 'false'},
+                    {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
+                ]
+            )
         },
     )
     template.has_resource('AWS::EFS::FileSystem', {'DeletionPolicy': 'Delete'})
@@ -160,10 +238,12 @@ def test_production_default_enabled_backup(stack, vpc, environment_parameters):
     template.has_resource_properties(
         'AWS::EFS::FileSystem',
         {
-            'FileSystemTags': [
-                {'Key': 'HasBackup', 'Value': 'true'},
-                {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
-            ]
+            'FileSystemTags': Match.array_with(
+                [
+                    {'Key': 'HasBackup', 'Value': 'true'},
+                    {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
+                ]
+            )
         },
     )
 
@@ -183,9 +263,11 @@ def test_production_disabled_backup(stack, vpc, environment_parameters):
     template.has_resource_properties(
         'AWS::EFS::FileSystem',
         {
-            'FileSystemTags': [
-                {'Key': 'HasBackup', 'Value': 'false'},
-                {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
-            ]
+            'FileSystemTags': Match.array_with(
+                [
+                    {'Key': 'HasBackup', 'Value': 'false'},
+                    {'Key': 'Name', 'Value': 'test-stack/volume-id-efs'},
+                ]
+            )
         },
     )