Update to version v1.4.0

Author: aassadza

.gitignore

@@ -7,7 +7,7 @@
 *.bin
 .staging
 .DS_STORE
-node_modules/
+**/node_modules
 venv/
 __pycache__/
 .pytest_cache

CHANGELOG.md

@@ -1,36 +1,55 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2020-11-23
+
+### Added
+
+- Implementation to use [AWS Cloud Development Kit (AWS CDK)](https://aws.amazon.com/cdk/) and architecture patterns from [AWS Solutions Constructs](https://aws.amazon.com/solutions/constructs/) to create AWS CloudFormation template.
+  - aws-cognito-apigateway-lambda.
+  - aws-lambda-dynamodb.
+  - aws-cloudfront-s3
+  - aws-s3-lambda
+  - aws-lambda-s3.
+
 ## [1.3.0] - 2020-10-27
+
 ### Added
+
 - A dynamic chatbot that demonstrates how to integrate a chatbot with a back-end database, such as Amazon DynamoDB, to build an automated order taking service (in this example, a pizza ordering service).
 - When the customer starts their order, the chatbot retrieves the pizza menu from the back-end database, and displays it to the customer.
 - The chatbot interacts with the customer to extract order details (for example, type and size of the pizza) and confirms the order.
 - The order history is stored in a DynamoDB table, which helps facilitate a personalized customer experience.
 - Functionality to automatically extract user's email, used by Amazon Cognito to authenticate the user with Amazon API Gateway, to use it as customerId.
 
 ## [1.2.0] - 2020-6-30
+
 ### Added
+
 - Support for using API keys to get weather data.
 - Functionality to write customer feedback to DynamoDB.
 
 ### Changed
+
 - Synchronized audio and text response in sample web client.
 
 ## [1.1.0] - 2020-3-30
+
 ### Added
+
 - Cognito with Amplify javascript framework to have sign-in/register in place for secure access to the web application.
 - Encryption to all S3 and logging S3 buckets.
 - Cloudfront to the web app hosted in S3. Restricted access to the web app S3 bucket to Cloudfront only.
 
 ### Changed
+
 - Re-implemented the user interface in ReactJS (previously implemented with vanilla Javascript) to make it easier to add or modify components for later updates.
 - Syntax for lambda functions in node8 to node12
 - Syntax for lambda functions in python2 to python3
 - The Solution Helper package to the newest version compatible with python3
 - Integrated Cognito user pool authentication with API Gateway and removed authorization with stored API Keys.
 - License changed to Apache License 2.0
-

README.md

@@ -1,18 +1,30 @@
 # Serverless Bot Framework
-The Serverless Bot Framework is a collection of AWS services combined into a single solution that any company can use to have a scalable and high-available multi-language audiobot, chatbot and touch interface with their customers.
 
+The Serverless Bot Framework is a collection of AWS services combined into a single solution that any company can use to have a scalable and high-available multi-language audiobot, chatbot and touch interface with their customers.
 
 ## On this Page
+
 - [Architecture Overview](#architecture-overview)
 - [Deployment](#deployment)
 - [Source Code](#source-code)
 - [Creating a custom build](#additional-resources)
 
-
 ## Architecture Overview
+
 ![Architecture](deployment/architecture.png)
 
+## AWS CDK Constructs
+
+[AWS CDK Solutions Constructs](https://aws.amazon.com/solutions/constructs/) make it easier to consistently create well-architected applications. All AWS Solutions Constructs are reviewed by AWS and use best practices established by the AWS Well-Architected Framework. This solution uses the following AWS CDK Constructs:
+
+- aws-cognito-apigateway-lambda.
+- aws-lambda-dynamodb.
+- aws-cloudfront-s3
+- aws-s3-lambda
+- aws-lambda-s3.
+
 ## Deployment
+
 The solution is deployed using a CloudFormation template with a lambda backed custom resource. For details on deploying the solution please see the details on the solution home page: [Serverless Bot Framework](https://aws.amazon.com/solutions/serverless-bot-framework/)
 
 ## Source Code
@@ -29,43 +41,57 @@ Includes source code for three lambda functions, core, custom-resource, and poll
 **source/services/custom-resource**
 A Python Lambda function used as a CloudFormation custom resource for configuring Amazon S3 bucket notifications and to send anonymous metrics.
 
-
 ## Creating a custom build
+
 The solution can be deployed through the CloudFormation template available on the solution home page: [Serverless Bot Framework](https://aws.amazon.com/solutions/implementations/serverless-bot-framework/).
 To make changes to the solution, download or clone this repo, update the source code and then run the deployment/build-s3-dist.sh script to deploy the updated Lambda code to an Amazon S3 bucket in your account.
 
 ### Prerequisites:
-* [AWS Command Line Interface](https://aws.amazon.com/cli/)
-* Node.js 12.x or later
-* (Optional) [AccuWeather](https://developer.accuweather.com/) or [OpenWeather](https://openweathermap.org/api) API keys
 
-### 1. Create an Amazon S3 Bucket
-The CloudFormation template is configured to pull the Lambda deployment packages from Amazon S3 bucket in the region the template is being launched in. Create a bucket in the desired region with the region name appended to the name of the bucket. eg: for us-east-1 create a bucket named: ```my-bucket-us-east-1```
-```
-aws s3 mb s3://my-bucket-us-east-1
-```
+- [AWS Command Line Interface](https://aws.amazon.com/cli/)
+- Node.js 12.x or later
+- (Optional) [AccuWeather](https://developer.accuweather.com/) or [OpenWeather](https://openweathermap.org/api) API keys
+
+### 1. Create the deployment packages
 
-### 2. Create the deployment packages
 Build the distributable:
+
 ```
+ARTIFACT_BUCKET=my-bucket-name     # S3 bucket name where customized code will reside
+SOLUTION_NAME=my-solution-name     # customized solution name
+VERSION=my-version                 # version number for the customized code
+
+cd ./deployment
 chmod +x ./build-s3-dist.sh
-./build-s3-dist.sh my-bucket serverless-bot-framework %%VERSION%%-custom
+./build-s3-dist.sh $ARTIFACT_BUCKET $SOLUTION_NAME $VERSION
 ```
 
 > **Notes**: The _build-s3-dist_ script expects the bucket name as one of its parameters, and this value should not include the region suffix. In addition to that, the version parameter will be used to tag the npm packages, and therefore should be in the [Semantic Versioning format](https://semver.org/spec/v2.0.0.html).
 
+### 2. Create Amazon S3 Buckets
+
+The CloudFormation template is configured to pull the Lambda deployment packages from Amazon S3 buckets in the region the template is being launched in. You need to create two buckets in the desired region. The names of the buckets should be `$ARTIFACT_BUCKET` and `$ARTIFACT_BUCKET-<region-name>`. For example, the following will create two buckets in the us-east-1 region.
+
+```
+aws s3 mb s3://$ARTIFACT_BUCKET --region us-east-1
+aws s3 mb s3://$ARTIFACT_BUCKET-us-east-1 --region us-east-1
+```
+
 Deploy the distributable to the Amazon S3 bucket in your account:
+
 ```
-aws s3 cp ./regional-s3-assets/ s3://my-bucket-us-east-1/serverless-bot-framework/%%VERSION%%-custom/ --recursive --acl bucket-owner-full-control
+aws s3 sync ./global-s3-assets s3://$ARTIFACT_BUCKET/$SOLUTION_NAME/$VERSION --acl bucket-owner-full-control
+aws s3 sync ./regional-s3-assets s3://$ARTIFACT_BUCKET-us-east-1/$SOLUTION_NAME/$VERSION --acl bucket-owner-full-control
 ```
 
 ### 3. Launch the CloudFormation template.
-* Get the link of the serverless-bot-framework.template uploaded to your Amazon S3 bucket.
-* Deploy the serverless bot framework to your account by launching a new AWS CloudFormation stack using the link of the serverless-bot-framework.template.
 
-***
+- Get the link of the serverless-bot-framework.template uploaded to your Amazon S3 bucket.
+- Deploy the serverless bot framework to your account by launching a new AWS CloudFormation stack using the link of the serverless-bot-framework.template.
+
+---
 
-Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.