feature: CDK 2 upgrade (#21)

* docs: update docs

* feature: cdk2 upgrade

Co-authored-by: Ran Isenberg <ran.isenberg@cyberark.com>

Author: ran-isenberg

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "cSpell.words": [
-        "Codecov"
+        "Codecov",
+        "ranisenberg"
     ]
 }

Pipfile.lock

@@ -1,17 +1,16 @@
 #!/usr/bin/env python3
 import os
 
-from aws_cdk import core
+from aws_cdk import App, Environment
 from boto3 import client, session
 from service_stack.constants import get_stack_name
 from service_stack.cookbook_stack import CookBookStack
 
 # pylint: disable=invalid-name
 account = client('sts').get_caller_identity()['Account']
 region = session.Session().region_name
-app = core.App()
-my_stack = CookBookStack(
-    app, get_stack_name(),
-    env=core.Environment(account=os.environ.get('AWS_DEFAULT_ACCOUNT', account), region=os.environ.get('AWS_DEFAULT_REGION', region)))
+app = App()
+my_stack = CookBookStack(app, get_stack_name(),
+                         env=Environment(account=os.environ.get('AWS_DEFAULT_ACCOUNT', account), region=os.environ.get('AWS_DEFAULT_REGION', region)))
 
 app.synth()

cdk/aws_lambda_handler_cookbook/app.py

@@ -2,11 +2,11 @@
 from pathlib import Path
 
 import boto3
-from aws_cdk import aws_apigateway
+from aws_cdk import CfnOutput, Duration, RemovalPolicy, aws_apigateway
 from aws_cdk import aws_iam as iam
 from aws_cdk import aws_lambda as _lambda
-from aws_cdk import core
-from aws_cdk.aws_lambda_python import PythonLayerVersion
+from aws_cdk.aws_lambda_python_alpha import PythonLayerVersion
+from constructs import Construct
 
 from .constants import (
     API_HANDLER_LAMBDA_MEMORY_SIZE,
@@ -26,10 +26,10 @@
 )
 
 
-class LambdaConstruct(core.Construct):
+class LambdaConstruct(Construct):
 
     # pylint: disable=invalid-name, no-value-for-parameter
-    def __init__(self, scope: core.Construct, id_: str) -> None:
+    def __init__(self, scope: Construct, id_: str) -> None:
         super().__init__(scope, id_)
 
         self.lambda_role = self._build_lambda_role()
@@ -48,7 +48,7 @@ def _build_api_gw(self) -> aws_apigateway.LambdaRestApi:
             deploy_options=aws_apigateway.StageOptions(throttling_rate_limit=2, throttling_burst_limit=10),
         )
 
-        core.CfnOutput(self, id=APIGATEWAY, value=rest_api.url).override_logical_id(APIGATEWAY)
+        CfnOutput(self, id=APIGATEWAY, value=rest_api.url).override_logical_id(APIGATEWAY)
         return rest_api
 
     def _build_lambda_role(self) -> iam.Role:
@@ -66,7 +66,7 @@ def _build_common_layer(self) -> PythonLayerVersion:
             'CommonLayer',
             entry=COMMION_LAYER_BUILD_FOLDER,
             compatible_runtimes=[_lambda.Runtime.PYTHON_3_8],
-            removal_policy=core.RemovalPolicy.DESTROY,
+            removal_policy=RemovalPolicy.DESTROY,
         )
 
     def __add_get_lambda_integration(self, api_name: aws_apigateway.Resource):
@@ -84,7 +84,7 @@ def __add_get_lambda_integration(self, api_name: aws_apigateway.Resource):
             },
             tracing=_lambda.Tracing.ACTIVE,
             retry_attempts=0,
-            timeout=core.Duration.seconds(API_HANDLER_LAMBDA_TIMEOUT),
+            timeout=Duration.seconds(API_HANDLER_LAMBDA_TIMEOUT),
             memory_size=API_HANDLER_LAMBDA_MEMORY_SIZE,
             layers=[self.common_layer],
         )

cdk/aws_lambda_handler_cookbook/service_stack/cookbook_construct.py

@@ -1,10 +1,11 @@
-from aws_cdk import core
+from aws_cdk import Stack
 from aws_lambda_handler_cookbook.service_stack.cookbook_construct import LambdaConstruct
+from constructs import Construct
 
 
-class CookBookStack(core.Stack):
+class CookBookStack(Stack):
 
     # pylint: disable=redefined-builtin
-    def __init__(self, scope: core.Construct, id: str, **kwargs) -> None:
+    def __init__(self, scope: Construct, id: str, **kwargs) -> None:
         super().__init__(scope, id, **kwargs)
         self.lambdas = LambdaConstruct(self, 'Service')

cdk/aws_lambda_handler_cookbook/service_stack/cookbook_stack.py

@@ -23,10 +23,8 @@
     include_package_data=True,
     python_requires='>=3.8',
     install_requires=[
-        'aws-cdk.aws-sam<2.0.0',
-        'aws-cdk.core<2.0.0',
-        'aws_cdk.aws_lambda<2.0.0',
-        'aws-cdk.aws_apigateway<2.0.0',
-        'aws-cdk.aws_lambda_python<2.0.0',
+        'aws-cdk-lib>=2.0.0',
+        'constructs>=10.0.0',
+        'aws-cdk.aws-lambda-python-alpha==2.16.0a0',
     ],
 )

cdk/setup.py

@@ -1,51 +1,17 @@
 -i https://pypi.org/simple
 -e ./cdk
 attrs==21.4.0
-aws-cdk.assets==1.147.0
-aws-cdk.aws-acmpca==1.147.0
-aws-cdk.aws-apigateway==1.147.0
-aws-cdk.aws-applicationautoscaling==1.147.0
-aws-cdk.aws-autoscaling-common==1.147.0
-aws-cdk.aws-certificatemanager==1.147.0
-aws-cdk.aws-cloudformation==1.147.0
-aws-cdk.aws-cloudwatch==1.147.0
-aws-cdk.aws-codeguruprofiler==1.147.0
-aws-cdk.aws-codestarnotifications==1.147.0
-aws-cdk.aws-cognito==1.147.0
-aws-cdk.aws-ec2==1.147.0
-aws-cdk.aws-ecr-assets==1.147.0
-aws-cdk.aws-ecr==1.147.0
-aws-cdk.aws-efs==1.147.0
-aws-cdk.aws-elasticloadbalancingv2==1.147.0
-aws-cdk.aws-events==1.147.0
-aws-cdk.aws-iam==1.147.0
-aws-cdk.aws-kms==1.147.0
-aws-cdk.aws-lambda-python==1.147.0
-aws-cdk.aws-lambda==1.147.0
-aws-cdk.aws-logs==1.147.0
-aws-cdk.aws-route53==1.147.0
-aws-cdk.aws-s3-assets==1.147.0
-aws-cdk.aws-s3==1.147.0
-aws-cdk.aws-sam==1.147.0
-aws-cdk.aws-signer==1.147.0
-aws-cdk.aws-sns==1.147.0
-aws-cdk.aws-sqs==1.147.0
-aws-cdk.aws-ssm==1.147.0
-aws-cdk.aws-stepfunctions==1.147.0
-aws-cdk.cloud-assembly-schema==1.147.0
-aws-cdk.core==1.147.0
-aws-cdk.custom-resources==1.147.0
-aws-cdk.cx-api==1.147.0
-aws-cdk.region-info==1.147.0
-boto3==1.21.13
-botocore==1.24.13
+aws-cdk-lib==2.16.0
+aws-cdk.aws-lambda-python-alpha==2.16.0a0
+boto3==1.21.20
+botocore==1.24.20
 cattrs==1.10.0 ; python_version >= '3.7'
 certifi==2021.10.8
 cfgv==3.3.1
 charset-normalizer==2.0.12 ; python_version >= '3'
 click==8.0.4
 colorama==0.4.4 ; python_version > '3.4'
-constructs==3.3.234
+constructs==10.0.89
 coverage[toml]==6.3.2
 distlib==0.3.4
 filelock==3.6.0
@@ -54,22 +20,22 @@ future==0.18.2
 ghp-import==2.0.2
 gitdb==4.0.9
 gitpython==3.1.27
-identify==2.4.11
+identify==2.4.12
 idna==3.3
-importlib-metadata==4.11.2 ; python_version < '3.10'
+importlib-metadata==4.11.3 ; python_version < '3.10'
 iniconfig==1.1.1
 isort==5.10.1
 jinja2==3.0.3
 jmespath==0.10.0
-jsii==1.54.0
+jsii==1.55.1
 mando==0.6.4
 markdown==3.3.6
-markupsafe==2.1.0
+markupsafe==2.1.1
 mccabe==0.6.1
 mergedeep==1.3.4
-mkdocs-git-revision-date-plugin==0.3.1
+mkdocs-git-revision-date-plugin==0.3.2
 mkdocs-material-extensions==1.0.3
-mkdocs-material==8.2.4
+mkdocs-material==8.2.5
 mkdocs==1.2.3
 nodeenv==1.6.0
 packaging==21.3
@@ -87,7 +53,7 @@ pytest-cov==3.0.0
 pytest-html==3.1.1
 pytest-metadata==1.11.0
 pytest-mock==3.7.0
-pytest==7.0.1
+pytest==7.1.0
 python-dateutil==2.8.2
 python-dotenv==0.19.2
 pyyaml-env-tag==0.1
@@ -100,8 +66,8 @@ smmap==5.0.0
 toml==0.10.2
 tomli==2.0.1
 typing-extensions==4.1.1
-urllib3==1.26.8
-virtualenv==20.13.2
+urllib3==1.26.9
+virtualenv==20.13.3
 watchdog==2.1.6
 xenon==0.9.0
 yapf==0.32.0

dev_requirements.txt

@@ -6,7 +6,7 @@ Environment Variables decorator is a simple parser for environment variables tha
 
 ![Environment Variables](../media/pydantic.png){: style="height:50%;width:20%"}
 
-## Key features
+## **Key features**
 * A defined [Pydantic](https://pydantic-docs.helpmanual.io/){:target="_blank" rel="noopener"} schema for all required environment variables
 * A decorator that parses and validates environment variables, value constraints included
 * Global getter for parsed & valid schema dataclass with all environment variables
@@ -18,11 +18,11 @@ The best practice for handling environment variables is to validate & parse them
 In case of misconfiguration, a validation exception is raised with all the relevant exception details.
 
 
-## Blog Reference
+## **Blog Reference**
 Read more about the importance of validating environment variables and how this utility works. Click [**HERE**](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-environment-variables){:target="_blank" rel="noopener"}
 
 
-## Schema Definition
+## **Schema Definition**
 
 You need to define all your environment variables in a Pydantic schema class that extend Pydantic's BaseModel class.
 
@@ -55,7 +55,7 @@ This schema makes sure that:
 
 Read [here](https://pydantic-docs.helpmanual.io/usage/models/){:target="_blank" rel="noopener"} about Pydantic Model capabilities.
 
-## Decorator Usage
+## **Decorator Usage**
 The decorator 'init_environment_variables' is defined under the utility folder **service.utils.env_vars_parser.py** and imported in the handler.
 
 The decorator requires a **model** parameter, which in this example is the name of the schema class we defined above.
@@ -78,7 +78,7 @@ The decorator requires a **model** parameter, which in this example is the name
         return {'statusCode': HTTPStatus.OK, 'headers': {'Content-Type': 'application/json'}, 'body': json.dumps({'message': 'success'})}
     ```
 
-## Global Getter Usage
+## **Global Getter Usage**
 The getter function 'get_environment_variables' is defined under the utility folder **service.utils.env_vars_parser.py** and imported in the handler.
 
 The getter function returns a parsed and validated global instance of the environment variables Pydantic schema class.
@@ -106,7 +106,7 @@ It can be used *anywhere* in the function code, not just the handler.
 
 
 
-## More Details
+## **More Details**
 
 Read [here](https://pydantic-docs.helpmanual.io/usage/types/){:target="_blank" rel="noopener"} about Pydantic field types.
 

docs/best_practices/environment_variables.md

@@ -6,19 +6,19 @@ It’s a wrapper of Python’s logging library that provides extra capabilities
 
 ![Logger](../media/logger.png)
 
-## Key features
+## **Key features**
 
 * Capture key fields from Lambda context, cold start and structures logging output as JSON
 * Log Lambda event when instructed (disabled by default)
 * Append additional keys to structured log at any point in time
 
 
-## Usage in Handler
+## **Usage in Handler**
 The logger is a singleton which is defined under the utility folder **service.utils.observability.py** and imported in the handler.
 
-## Blog Reference
+## **Blog Reference**
 Read more about the importance of the logger and how to use AWS CloudWatch logs in my blog. Click [**HERE**](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-elevate-your-handler-s-code-part-1-logging){:target="_blank" rel="noopener"}
 
 
-## More Details
+## **More Details**
 You can find more information at the official documentation. Go to [https://awslabs.github.io/aws-lambda-powertools-python/latest/core/logger/](https://awslabs.github.io/aws-lambda-powertools-python/latest/core/logger/){:target="_blank" rel="noopener"}

docs/best_practices/logger.md

@@ -12,19 +12,19 @@ These metrics can be visualized through [Amazon CloudWatch Console](https://cons
 
 ![Metrics](../media/metrics.png)
 
-## Key features
+## **Key features**
 
 * Aggregate up to 100 metrics using a single CloudWatch EMF object (large JSON blob)
 * Validate against common metric definitions mistakes (metric unit, values, max dimensions, max metrics, etc)
 * Metrics are created asynchronously by CloudWatch service, no custom stacks needed
 
 
-## Usage in Handler
+## **Usage in Handler**
 The metrics is a singleton which is defined under the utility folder **service.utils.observability.py** and imported in the handler.
 
-## Blog Reference
+## **Blog Reference**
 Read more about the importance of the business KPis and metrics in my blog. Click [**HERE**](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-elevate-your-handler-s-code-part-3-business-domain-observability){:target="_blank" rel="noopener"}
 
 
-## More Details
+## **More Details**
 You can find more information at the official documentation. Go to [https://awslabs.github.io/aws-lambda-powertools-python/latest/core/metrics/](https://awslabs.github.io/aws-lambda-powertools-python/latest/core/metrics/){:target="_blank" rel="noopener"}