AWS Shop

Overview

AWS is a broad ecosystem for modernizing applications in the cloud. Due to its sheer size, it can be daunting for newcomers to dip their toes into the world of AWS. There are hundreds of services to choose from with their own pricing models. It's easy to rack up a high AWS bill if you're not careful, but there are plenty of services with a generous free tier that are simple for beginners to use. This is the main inspiration behind AWS Shop.

(Note that this is not meant to replace any training or certifications from AWS, but is a good way to get a high-level overview of all the main AWS services, whether you're new to AWS or need a refresher.)

This is a basic shopping app that utilizes various AWS services. It is designed to help users new to AWS understand what each service offers and their costs. Similar to How to Stock, users are provided a certain budget to simulate purchasing AWS services for their own projects. The architecture is designed with cost optimization and operational excellence in mind. Serverless tools help reduce the costs and everything is written as code to help test, version, and automate much of the application, infrastructure, and security of the project.

The front-end is a React app where users can browse many different AWS services in a simulated e-commerce environment. Each service is split into multiple categories based on the type of free tier AWS provides.

The back-end is a collection of microservices written in Python. The main one is an API that manages the AWS services stored in a database to display on the front-end. Other microservices help with automating everyday tasks and managing the AWS environment, including monitoring the health of AWS services, the age of access keys, and configurations that aren't compliant with AWS's best practices.

For each service, CI/CD pipelines are written using GitHub Actions to automate unit testing, integration testing, security testing, and deployments of both applications and infrastructure. Health checks are used to monitor both the front-end and back-end, and email notifications are sent if any resource is unhealthy.

Architecture Diagram

Created using draw.io

Front End

• CodeBuild is used to test the React app, build it, and deploy to S3.
• The S3 bucket will hold the optimized production build for the React app. Since CloudFront will host the website, we don't need to enable static website hosting on the bucket. A bucket policy was created to only make the website accessible by a secure CloudFront distribution. This way, we can block public access from the S3 bucket.
• CloudFront hosts the website across multiple edge locations across North America, Europe, and Israel (to save on costs). It uses Origin Access Control (OAC) to securely connect to S3 as its origin.
• Cognito handles authentication so users can manage their profiles.

Back End

• Information about all the AWS services is stored in a DynamoDB table. Global Secondary Indexes (GSIs) are used to help improve the performance of queries by certain filters, such as searching for services by price or category.
• A Lambda function handles the logic by the client to perform the appropriate CRUD operations on the DynamoDB table.
• A 2nd Lambda function handles sending events to Pinpoint for analytics.
• The API is contructed using API Gateway. An OpenAPI spec defines which endpoints the client can call and how API Gateway transforms the requests and responses from Lambda. Rate limiting is applied to prevent heavy usage of the API.
• The API is then exposed to the client using CloudFront to improve performance via caching and edge locations. It also reduces the amount of API calls made to the rest of the back-end.
• On failure, a dead-letter queue (DLQ) is used to collect error messages from Lambda.

Pipeline Diagrams

Node.js (Front-End)

flowchart LR

A --> B

subgraph A [Build]
direction TB
C(Checkout repository) -->|18.x, 20.x| D(Install Node.js)
D --> E(Install dependencies:\nnpm ci)
E --> F(Lint app:\nnpm run lint --if-present)
F --> G(Build app:\nnpm run build --if-present)
G --> H(Run tests:\nnpm test)
end

subgraph B [Deploy]
direction TB
I(Checkout repository) --> J(Configure AWS credentials)
J --> K
end

subgraph K [Run CodeBuild Project]
direction TB
L(Install Node 20) --> M(Install dependencies:\nnpm ci)
M --> N(Run tests:\nnpm test)
N --> O(Build app:\nnpm run build)
O --> P(Delete old code in S3)
P --> Q(Upload new code to S3)
Q --> R(Invalidate cache in CloudFront)
end

Loading

Python (Back-End)

flowchart LR

A --> B

subgraph A [Build]
direction TB
C(Checkout repository) --> D(Configure AWS credentials)
D -->|3.10, 3.11, 3.12| E(Install Python)
E --> F(Install dependencies:\npip install -r requirements.txt)
F --> G(Run tests:\npytest)
end

subgraph B [Deploy]
direction TB
H(Checkout repository) --> I(Install SAM)
I --> J(Configure AWS credentials)
J --> K(Build SAM app:\nsam build)
K --> L(Deploy SAM app:\nsam deploy)
end

Loading

CloudFormation

flowchart LR

A --> B
B --> C

subgraph A [Get Templates]
direction TB
D(Checkout repository) --> E(Get all CloudFormation templates, parameters, and stack names)
end

subgraph B [Build]
direction TB
F(Get the template and stack name) --> |For each template| G(Checkout repository)
G --> H(Configure AWS credentials)
H --> I(Validate template:\naws cloudformation validate-template)
I --> J(Detect stack drift:\n./detect-stack-drift.sh)
J --> K(Install cfn-guard)
K --> L(Scan for vulnerabilities:\ncfn-guard validate)
end

subgraph C [Deploy]
direction TB
M(Get the template and stack name) --> |For each template| N(Checkout repository)
N --> O(Configure AWS credentials)
O --> P(Update stack on CloudFormation)
end

Loading

CodeQL

flowchart LR

A(Checkout repository) -->|JavaScript,Python| B(Initialize CodeQL)
B --> C(Build code)
C --> D(Perform CodeQL analysis)

Loading

Directions

Both the front-end and back-end can be run locally without AWS. Directions for setting up each environment can be found in the shop-app and microservices directories respectively. To run the entire app in AWS:

1. Build the infrastructure using all the CloudFormation templates found here and in the microservices directory. They can be identified as YAML files that contain AWSTemplateFormatVersion.
2. Use CodeBuild to test the React app, build it, and upload the build to S3.
3. Open https://d23f1hp5lvetow.cloudfront.net/ in the browser.

Using the CLI

Download the AWS CLI. Then run aws configure and pass in your access key ID, secret access key, default region, and default ouput format. (Run aws sts get-caller-identity to verify you're signed in as the right user.)

CloudFormation Commands

Create stack:

aws cloudformation create-stack --stack-name NAME --template-body FILE_PATH --parameters ParameterKey=KEY,ParameterValue=VALUE --capabilities CAPABILITY_NAMED_IAM

List stacks:

aws cloudformation list-stacks
aws cloudformation describe-stacks # more detailed than list-stacks

Update stack:

aws cloudformation update-stack --stack-name NAME --template-body FILE_PATH --parameters PARAM_FILE_PATH --capabilities CAPABILITY_NAMED_IAM

Continue update rollback:

aws cloudformation continue-update-rollback --stack-name NAME [--resources-to-skip RESOURCE]

Delete stack:

aws cloudformation delete-stack --stack-name NAME

Detect stack drift:

aws cloudformation detect-stack-drift --stack-name NAME

Describe stack drift:

aws cloudformation describe-stack-resource-drifts --stack-name NAME --stack-resource-drift-status-filters DELETED MODIFIED

Describe stack drift status:

aws cloudformation describe-stack-drift-detection-status --stack-drift-detection-id DRIFT_ID

Create change set:

aws cloudformation create-change-set --stack-name NAME --change-set-name CHANGE_SET --template-body FILE_PATH --parameters PARAM_FILE_PATH --capabilities CAPABILITY_NAMED_IAM

List change sets:

aws cloudformation list-change-sets --stack-name my-stack

Describe change set:

aws cloudformation describe-change-set --stack-name NAME --change-set-name CHANGE_SET

Execute change set:

aws cloudformation execute-change-set --stack-name NAME --change-set-name CHANGE_SET

Delete change set:

aws cloudformation delete-change-set --stack-name NAME --change-set-name CHANGE_SET

cfn-guard

To run a security check of a CloudFormation template, follow these steps to install cfn-guard. Then run:

cfn-guard validate --show-summary [pass|fail] --output-format [single-line-summary|json|yaml] --data FILE --rules cfn-guard-rules/

CodeBuild Commands

Start build:

aws codebuild start-build --project-name NAME

List projects:

aws codebuild list-projects

List builds:

aws codebuild list-builds
aws codebuild list-builds-for-project --project-name NAME

Stop build:

aws codebuild stop-build --id BUILD_ID

S3 Commands

List objects:

aws s3 ls S3_URI

Lambda Commands

Invoke function:

aws lambda invoke --cli-binary-format raw-in-base64-out --function-name FUNCTION --payload EVENT_FILE_PATH response.json [--log-type Tail] [--endpoint-url http://localhost:3001] [--query 'LogResult' --output text | base64 --decode]

CloudWatch Logs Commands

Get log groups:

aws logs describe-log-groups --query logGroups[*].logGroupName

Get log streams:

aws logs describe-log-streams --log-group-name GROUP --query logStreams[*].logStreamName

Get log events:

aws logs get-log-events --log-group-name GROUP --log-stream-name STREAM

DynamoDB Commands

List tables:

aws dynamodb list-tables

Describe table:

aws dynamodb describe-table --table-name TABLE_NAME

Scan table:

aws dynamodb scan --table-name AWS-Services --index-name INDEX --projection-expression "Name, Price" --filter-expression "Category = :free" --expression-attribute-values file://attributes.json --return-consumed-capacity TOTAL

Query table:

aws dynamodb query --table-name AWS-Services --index-name INDEX --projection-expression "Name, Price" --key-condition-expression "Category = :free" --expression-attribute-values file://attributes.json --return-consumed-capacity TOTAL

Query table using PartiQL:

aws dynamodb execute-statement --statement "SELECT Name, Price FROM \"AWS-Services\".\"INDEX\" WHERE Category = 'free'" --return-consumed-capacity TOTAL --return-values-on-condition-check-failure ALL_OLD

Update table:

aws dynamodb batch-write-item --request-items file://aws-services.json --return-consumed-capacity INDEXES --return-item-collection-metrics SIZE

SQS Commands

Receive messages:

aws sqs receive-message --queue-url URL --message-attribute-names All --message-system-attribute-names All --max-number-of-messages 10

Delete message:

aws sqs delete-message --queue-url URL --receipt-handle HANDLE

Purge queue:

aws sqs purge-queue --queue-url URL

KMS Commands

List aliases:

aws kms list-aliases

Route 53 Commands

List all health checks:

aws route53 list-health-checks

Get health check status:

aws route53 get-health-check-status --health-check-id ID

Cognito Commands

List user pools:

aws cognito-idp list-user-pools --max-results 20
aws cognito-idp describe-user-pool --user-pool-id ID

Describe user pool domain:

aws cognito-idp describe-user-pool-domain --domain DOMAIN

List user pool clients:

aws cognito-idp list-user-pool-clients --user-pool-id ID
aws cognito-idp describe-user-pool-client --user-pool-id ID --client-id CLIENT_ID

List users:

aws cognito-idp list-users --user-pool-id ID

Sign up (public):

aws cognito-idp sign-up --client-id CLIENT_ID --username USERNAME --password PASSWORD [--user-attributes Name="NAME",Value="VALUE"...]
aws cognito-idp confirm-sign-up --client-id CLIENT_ID --username USERNAME --confirmation-code CODE
aws cognito-idp resend-confirmation-code --client-id CLIENT_ID --username USERNAME

Sign up (admin):

aws cognito-idp admin-create-user --user-pool-id ID --username USERNAME [--user-attributes Name="NAME",Value="VALUE"...] [--message-action SUPPRESS]
aws cognito-idp admin-confirm-sign-up --user-pool-id ID --username USERNAME

Sign in (public):

aws cognito-idp initiate-auth --client-id CLIENT_ID --auth-flow [USER_SRP_AUTH|REFRESH_TOKEN_AUTH] --auth-parameters [USERNAME=EMAIL,SRP_A=SRP|REFRESH_TOKEN=TOKEN]
aws cognito-idp respond-to-auth-challenge --client-id CLIENT_ID [--session SESSION] --challenge-name PASSWORD_VERIFIER --challenge-responses PASSWORD_CLAIM_SIGNATURE=SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK=BLOCK,TIMESTAMP=TIME,USERNAME=EMAIL

Sign in (admin):

aws cognito-idp admin-initiate-auth --user-pool-id ID --client-id CLIENT_ID --auth-flow [USER_SRP_AUTH|REFRESH_TOKEN_AUTH] --auth-parameters [USERNAME=EMAIL,SRP_A=SRP|REFRESH_TOKEN=TOKEN]
aws cognito-idp admin-respond-to-auth-challenge --user-pool-id ID --client-id CLIENT_ID [--session SESSION] --challenge-name PASSWORD_VERIFIER --challenge-responses PASSWORD_CLAIM_SIGNATURE=SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK=BLOCK,TIMESTAMP=TIME,USERNAME=EMAIL

Update user attributes (public):

aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="NAME",Value="VALUE"
aws cognito-idp verify-user-attribute --access-token ACCESS_TOKEN --attribute-name NAME --code CODE

Update user attributes (admin):

aws cognito-idp admin-update-user-attributes --user-pool-id ID --username USERNAME --user-attributes Name="NAME",Value="VALUE"

Change password:

aws cognito-idp change-password --previous-password OLD_PASSWORD --proposed-password NEW_PASSWORD --access-token ACCESS_TOKEN

Delete user (public):

aws cognito-idp delete-user --access-token ACCESS_TOKEN

Delete user (admin):

aws cognito-idp admin-disable-user --user-pool-id ID --username USERNAME
aws cognito-idp admin-delete-user --user-pool-id ID --username USERNAME

Pinpoint Commands

Publish event:

aws pinpoint put-events --application-id ID --events-request EVENT_FILE_PATH

Get endpoint:

aws pinpoint get-endpoint --application-id ID --endpoint-id ENDPOINT_ID

Rotating Access Keys

Rotate your access keys every 60 days by running the following shell script (jq is required):

chmod u+x rotate-access-key.sh
./rotate-access-key.sh