use cdk context instead of CfnParameter

Author: ksmin23

README.md

@@ -60,40 +60,32 @@ For more information about how to create a package for Amazon Lambda Layer, see
 
 ### Deploy
 
-At this point you can now synthesize the CloudFormation template for this code.
+Before to synthesize the CloudFormation template for this code, you should update `cdk.context.json` file.<br/>
+In particular, you need to fill the s3 location of the previously created lambda lay codes.
+
+For example,
+<pre>
+{
+  "firehose_data_tranform_lambda": {
+    "s3_bucket_name": "<i>lambda-layer-resources</i>",
+    "s3_object_key": "<i>var/fastavro-lib.zip</i>"
+  },
+  ....
+}
+</pre>
+
+Now you are ready to synthesize the CloudFormation template for this code.<br/>
 
 <pre>
 (.venv) $ export CDK_DEFAULT_ACCOUNT=$(aws sts get-caller-identity --query Account --output text)
 (.venv) $ export CDK_DEFAULT_REGION=$(curl -s 169.254.169.254/latest/dynamic/instance-identity/document | jq -r .region)
-(.venv) $ cdk synth WebAnalyticsVpc
-(.venv) $ cdk synth WebAnalyticsKdsProxyApiGw
-(.venv) $ cdk synth WebAnalyticsKinesisStream \
-              --parameters KinesisStreamName=<i>'your-kinesis-data-stream-name'</i> \
-(.venv) $ cdk synth WebAnalyticsFirehoseDataTransformLambda \
-              --parameters LambdaLayerCodeS3BucketName=<i>'your-s3-bucket-name-for-lambda-layer-code'</i> \
-              --parameters LambdaLayerCodeS3ObjectKey=<i>'your-s3-object-key-for-lambda-layer-code'</i>
-(.venv) $ cdk synth WebAnalyticsFirehose \
-              --parameters FirehoseStreamName=<i>'your-delivery-stream-name'</i>
-(.venv) $ cdk synth WebAnalyticsAthenaWorkGroup
-(.venv) $ cdk synth WebAnalyticsMergeSmallFiles
-(.venv) $ cdk synth WebAnalyticsAthenaNamedQueries
+(.venv) $ cdk synth --all
 </pre>
 
 Use `cdk deploy` command to create the stack shown above.
 
 <pre>
-(.venv) $ cdk deploy --require-approval never WebAnalyticsVpc
-(.venv) $ cdk deploy --require-approval never WebAnalyticsKdsProxyApiGw
-(.venv) $ cdk deploy --require-approval never WebAnalyticsKinesisStream \
-              --parameters KinesisStreamName=<i>'your-kinesis-data-stream-name'</i> \
-(.venv) $ cdk deploy --require-approval never WebAnalyticsFirehoseDataTransformLambda \
-              --parameters LambdaLayerCodeS3BucketName=<i>'your-s3-bucket-name-for-lambda-layer-code'</i> \
-              --parameters LambdaLayerCodeS3ObjectKey=<i>'your-s3-object-key-for-lambda-layer-code'</i>
-(.venv) $ cdk deploy --require-approval never WebAnalyticsFirehose \
-              --parameters FirehoseStreamName=<i>'your-delivery-stream-name'</i>
-(.venv) $ cdk deploy --require-approval never WebAnalyticsAthenaWorkGroup
-(.venv) $ cdk deploy --require-approval never WebAnalyticsMergeSmallFiles
-(.venv) $ cdk deploy --require-approval never WebAnalyticsAthenaNamedQueries
+(.venv) $ cdk deploy --require-approval never --all
 </pre>
 
 To add additional dependencies, for example other CDK libraries, just add

app.py

@@ -26,27 +26,33 @@
 
 firehose_data_transform_lambda = FirehoseDataTransformLambdaStack(app,
   'WebAnalyticsFirehoseDataTransformLambda')
+firehose_data_transform_lambda.add_dependency(vpc_stack)
 
 firehose_stack = FirehoseStack(app, 'WebAnalyticsFirehose',
   kds_stack.target_kinesis_stream.stream_arn,
   firehose_data_transform_lambda.schema_validator_lambda_fn)
+firehose_stack.add_dependency(kds_stack)
+firehose_stack.add_dependency(firehose_data_transform_lambda)
 
 athena_work_group_stack = AthenaWorkGroupStack(app,
   'WebAnalyticsAthenaWorkGroup'
 )
+athena_work_group_stack.add_dependency(firehose_stack)
 
 merge_small_files_stack = MergeSmallFilesLambdaStack(app,
   'WebAnalyticsMergeSmallFiles',
   firehose_stack.s3_dest_bucket_name,
   firehose_stack.s3_dest_folder_name,
   athena_work_group_stack.athena_work_group_name
 )
+merge_small_files_stack.add_dependency(athena_work_group_stack)
 
-AthenaNamedQueryStack(app,
+athena_named_query_stack = AthenaNamedQueryStack(app,
   'WebAnalyticsAthenaNamedQueries',
   athena_work_group_stack.athena_work_group_name,
   merge_small_files_stack.s3_json_location,
   merge_small_files_stack.s3_parquet_location
 )
+athena_named_query_stack.add_dependency(merge_small_files_stack)
 
 app.synth()

cdk.context.json

@@ -1,4 +1,8 @@
 {
+  "firehose_data_tranform_lambda": {
+    "s3_bucket_name": "s3-bucket-name-for-lambda-layer-resources",
+    "s3_object_key": "var/fastavro-lib.zip"
+  },
   "firehose": {
     "buffer_size_in_mbs": 128,
     "buffer_interval_in_seconds": 300,

requirements.txt

@@ -1,2 +1,2 @@
-aws-cdk-lib==2.53.0
+aws-cdk-lib==2.55.1
 constructs>=10.0.0,<11.0.0

web_analytics/athena_workgroup.py

@@ -21,11 +21,7 @@ class AthenaWorkGroupStack(Stack):
   def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
     super().__init__(scope, construct_id, **kwargs)
 
-    ATHENA_WORK_GROUP_NAME = cdk.CfnParameter(self, 'AthenaWorkGroupName',
-      type='String',
-      description='Amazon Athena Workgroup Name',
-      default='WebAnalyticsGroup'
-    )
+    ATHENA_WORK_GROUP_NAME = self.node.try_get_context('athena_workgroup_name') or 'WebAnalyticsGroup'
 
     S3_BUCKET_SUFFIX = ''.join(random.sample((string.ascii_lowercase + string.digits), k=7))
     s3_bucket = s3.Bucket(self, "s3bucket",
@@ -34,15 +30,15 @@ def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         region=cdk.Aws.REGION, suffix=S3_BUCKET_SUFFIX))
 
     athena_cfn_work_group = aws_athena.CfnWorkGroup(self, 'AthenaCfnWorkGroup',
-      name=ATHENA_WORK_GROUP_NAME.value_as_string,
+      name=ATHENA_WORK_GROUP_NAME,
 
       # the properties below are optional
       description='workgroup for developer',
       recursive_delete_option=False,
       state='ENABLED', # [DISABLED, ENABLED]
       tags=[cdk.CfnTag(
         key='Name',
-        value=ATHENA_WORK_GROUP_NAME.value_as_string
+        value=ATHENA_WORK_GROUP_NAME
       )],
       work_group_configuration=aws_athena.CfnWorkGroup.WorkGroupConfigurationProperty(
         #XXX: EnforceWorkGroupConfiguration

web_analytics/firehose.py

@@ -27,14 +27,10 @@ def __init__(self, scope: Construct, construct_id: str, source_kinesis_stream_ar
       bucket_name="web-analytics-{region}-{suffix}".format(
         region=cdk.Aws.REGION, suffix=S3_BUCKET_SUFFIX))
 
-    FIREHOSE_STREAM_NAME = cdk.CfnParameter(self, 'FirehoseStreamName',
-      type='String',
-      description='kinesis data firehose name',
-      default='PUT-S3-{}'.format(''.join(random.sample((string.ascii_letters), k=5)))
-    )
-
+    FIREHOSE_DEFAULT_STREAM_NAME = 'PUT-S3-{}'.format(''.join(random.sample((string.ascii_letters), k=5)))
     firehose_config = self.node.try_get_context('firehose')
 
+    FIREHOSE_STREAM_NAME = firehose_config.get('stream_name', FIREHOSE_DEFAULT_STREAM_NAME)
     FIREHOSE_BUFFER_SIZE = firehose_config['buffer_size_in_mbs']
     FIREHOSE_BUFFER_INTERVAL = firehose_config['buffer_interval_in_seconds']
     FIREHOSE_LAMBDA_BUFFER_SIZE = firehose_config['lambda_buffer_size_in_mbs']
@@ -87,7 +83,7 @@ def __init__(self, scope: Construct, construct_id: str, source_kinesis_stream_ar
         "kinesis:GetRecords"]
     ))
 
-    firehose_log_group_name = f"/aws/kinesisfirehose/{FIREHOSE_STREAM_NAME.value_as_string}"
+    firehose_log_group_name = f"/aws/kinesisfirehose/{FIREHOSE_STREAM_NAME}"
     firehose_role_policy_doc.add_statements(aws_iam.PolicyStatement(
       effect=aws_iam.Effect.ALLOW,
       #XXX: The ARN will be formatted as follows:
@@ -112,7 +108,7 @@ def __init__(self, scope: Construct, construct_id: str, source_kinesis_stream_ar
 
     firehose_role = aws_iam.Role(self, "KinesisFirehoseDeliveryRole",
       role_name="KinesisFirehoseServiceRole-{stream_name}-{region}".format(
-        stream_name=FIREHOSE_STREAM_NAME.value_as_string, region=cdk.Aws.REGION),
+        stream_name=FIREHOSE_STREAM_NAME, region=cdk.Aws.REGION),
       assumed_by=aws_iam.ServicePrincipal("firehose.amazonaws.com"),
       #XXX: use inline_policies to work around https://github.com/aws/aws-cdk/issues/5221
       inline_policies={
@@ -179,7 +175,7 @@ def __init__(self, scope: Construct, construct_id: str, source_kinesis_stream_ar
     )
 
     firehose_to_s3_delivery_stream = aws_kinesisfirehose.CfnDeliveryStream(self, "KinesisFirehoseToS3",
-      delivery_stream_name=FIREHOSE_STREAM_NAME.value_as_string,
+      delivery_stream_name=FIREHOSE_STREAM_NAME,
       delivery_stream_type="KinesisStreamAsSource",
       kinesis_stream_source_configuration={
         "kinesisStreamArn": source_kinesis_stream_arn,

web_analytics/firehose_dtata_transform_lambda.py

@@ -17,21 +17,15 @@ class FirehoseDataTransformLambdaStack(Stack):
   def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
     super().__init__(scope, construct_id, **kwargs)
 
-    LAMBDA_LAYER_CODE_S3_BUCKET = cdk.CfnParameter(self, 'LambdaLayerCodeS3BucketName',
-      type='String',
-      description='S3 bucket for lambda layer codes'
-    )
-
-    LAMBDA_LAYER_CODE_S3_OBJ_KEY = cdk.CfnParameter(self, 'LambdaLayerCodeS3ObjectKey',
-      type='String',
-      description='S3 object key for lambda layer codes'
-    )
+    firehose_data_transform_lambda_config = self.node.try_get_context('firehose_data_tranform_lambda')
+    LAMBDA_LAYER_CODE_S3_BUCKET = firehose_data_transform_lambda_config['s3_bucket_name']
+    LAMBDA_LAYER_CODE_S3_OBJ_KEY = firehose_data_transform_lambda_config['s3_object_key']
 
-    s3_lambda_layer_lib_bucket = s3.Bucket.from_bucket_name(self, "LambdaLayerS3Bucket", LAMBDA_LAYER_CODE_S3_BUCKET.value_as_string)
+    s3_lambda_layer_lib_bucket = s3.Bucket.from_bucket_name(self, "LambdaLayerS3Bucket", LAMBDA_LAYER_CODE_S3_BUCKET)
     lambda_lib_layer = aws_lambda.LayerVersion(self, "SchemaValidatorLib",
       layer_version_name="fastavro-lib",
       compatible_runtimes=[aws_lambda.Runtime.PYTHON_3_9],
-      code=aws_lambda.Code.from_bucket(s3_lambda_layer_lib_bucket, LAMBDA_LAYER_CODE_S3_OBJ_KEY.value_as_string)
+      code=aws_lambda.Code.from_bucket(s3_lambda_layer_lib_bucket, LAMBDA_LAYER_CODE_S3_OBJ_KEY)
     )
 
     SCHEMA_VALIDATOR_LAMBDA_FN_NAME = "SchemaValidator"

web_analytics/kds.py

@@ -19,16 +19,13 @@ class KdsStack(Stack):
   def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
     super().__init__(scope, construct_id, **kwargs)
 
-    KINESIS_STREAM_NAME = cdk.CfnParameter(self, 'KinesisStreamName',
-      type='String',
-      description='kinesis data stream name',
-      default='PUT-Firehose-{}'.format(''.join(random.sample((string.ascii_letters), k=5)))
-    )
+    KINESIS_DEFAULT_STREAM_NAME = 'PUT-Firehose-{}'.format(''.join(random.sample((string.ascii_letters), k=5)))
+    KINESIS_STREAM_NAME = self.node.try_get_context('kinesis_stream_name') or KINESIS_DEFAULT_STREAM_NAME
 
     source_kinesis_stream = aws_kinesis.Stream(self, "SourceKinesisStreams",
       retention_period=Duration.hours(24),
       stream_mode=aws_kinesis.StreamMode.ON_DEMAND,
-      stream_name=KINESIS_STREAM_NAME.value_as_string)
+      stream_name=KINESIS_STREAM_NAME)
 
     self.target_kinesis_stream = source_kinesis_stream