README.md

Connected Mobility Solution on AWS - Alerts Module

Connected Mobility Solution on AWS | 🚧 Feature request | 🐛 Bug Report | ❓ General Question

Note: If you want to use the solution without building from source, navigate to the AWS Solution Page.

Table of Contents

• Connected Mobility Solution on AWS - Alerts Module
  • Table of Contents
  • Solution Overview
  • Architecture Diagram
  • Sequence Diagram
  • AWS CDK and Solutions Constructs
  • Customizing the Module
  • Prerequisites
    • MacOS Installation Instructions
    • Clone the Repository
    • Install Required Dependencies
    • Unit Test
    • Build the Module
    • Upload Assets to S3
    • Deploy on AWS
    • Delete
  • Cost Scaling
  • Collection of Operational Metrics
  • License

Solution Overview

CMS Alerts is a deployable module within Connected Mobility Solution on AWS (CMS) that enables a notification mechanism for vehicles and modules to send alerts to user via email. A User must subscribe to these notification via subscription management API provided in the module, and modules can send the notification via publish API.

For more information and a detailed deployment guide, visit the CMS Alerts Implementation Guide page.

Architecture Diagram

Sequence Diagram

AWS CDK and Solutions Constructs

AWS Cloud Development Kit (AWS CDK) and AWS Solutions Constructs make it easier to consistently create well-architected infrastructure applications. All AWS Solutions Constructs are reviewed by AWS and use best practices established by the AWS Well-Architected Framework.

In addition to the AWS Solutions Constructs, the solution uses AWS CDK directly to create infrastructure resources.

Customizing the Module

Prerequisites

• Python 3.12+
• NVM
• NPM 8+
• Node 18+
• Pipenv

MacOS Installation Instructions

Pyenv Github Repository

brew install pyenv
pyenv install 3.12

Pipenv Github Repository

pip install --user pipenv
pipenv sync --dev

NVM Github Repository

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

NPM/Node Official Documentation

nvm install 18
nvm use 18

Clone the Repository

git clone https://github.com/aws-solutions/connected-mobility-solution-on-aws.git
cd connected-mobility-solution-on-aws/source/modules/cms_alerts/

Install Required Dependencies

make install

Unit Test

After making changes, run unit tests to make sure added customization passes the tests:

make test

Build the Module

The build script manages dependencies, builds required assets (e.g. packaged lambdas), and creates the AWS Cloudformation templates.

make build

Upload Assets to S3

make upload

Deploy on AWS

make deploy

Delete

make destroy
python ./deployment/script_clean_sns_topic.py

Cost Scaling

Cost will scale depending on usage of the API, and number of subscriptions and notifications.

• AWS AppSync Cost
• Amazon SQS Cost
• AWS Lambda Cost
• Amazon DynamoDB Cost

For more details, see the implementation guide.

Collection of Operational Metrics

This solution collects anonymized operational metrics to help AWS improve the quality and features of the solution. For more information, including how to disable this capability, please see the implementation guide.

License

Copyright 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. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.