DynamoDB Local Sandbox

This is a simple project to demonstrate how to use DynamoDB Local. The project includes a simple Flask application, and also provides a local admin interface to facilitate the management of tables and items.

Requirements

• Python 3.12
• Docker Desktop (or compatible container runtime offering docker-compose)
• AWS CLI (optional)

Setup

1. Clone the repository

git clone https://github.com/ThatsNinja/dynamodb-local.git

2. Change to the project directory

cd dynamodb-local

Running the Application

1. Start the Docker Compose stack

docker-compose up

This will result in DynamoDB Local running in a Docker container, which exposes the service on the host machine at port 8000. Additionally, you have an instance of the dynamodb-admin GUI interface exposed at port 8001.

The included Flask application is configured to start on port 5000. The application only exposes one path at this endpoint, which is a simple health check. You can access it at http://localhost:5000/healthcheck.

Things to Note

• The docker-compose.yml file includes a volume mount for the data directory. This is to facilitate the sharing the contents of the data directory at the project root with the Docker container running DynamoDB Local. This is where the data files are stored, which ensures that your DynamoDB Local data will not be destroyed by routine container operations.
• The included Flask app only tests the connection to DynamoDB Local. It does nothing meaningful in terms of interacting with the database.