Table of Contents

Installation

pip install dynamodump

Usage

usage: dynamodump.py [-h] [-a {zip,tar}] [-b BUCKET] [-m {backup,restore,empty}] [-r REGION] [--host HOST] [--port PORT] [--accessKey ACCESSKEY] [--secretKey SECRETKEY] [-p PROFILE] [-s SRCTABLE] [-d DESTTABLE]                     [--prefixSeparator PREFIXSEPARATOR] [--noSeparator] [--readCapacity READCAPACITY] [-t TAG] [--writeCapacity WRITECAPACITY] [--schemaOnly] [--dataOnly] [--noConfirm] [--skipThroughputUpdate]                     [--dumpPath DUMPPATH] [--billingMode {PROVISIONED,PAY_PER_REQUEST}] [--log LOG] [--limit LIMIT] [-f FILTEROPTION]Simple DynamoDB backup/restore/empty.options:  -h, --help            show this help message and exit  -a {zip,tar}, --archive {zip,tar}                        Type of compressed archive to create. If unset, don't create archive  -b BUCKET, --bucket BUCKET                        S3 bucket in which to store or retrieve backups. [must already exist]  -m {backup,restore,empty}, --mode {backup,restore,empty}                        Operation to perform  -r REGION, --region REGION                        AWS region to use, e.g. 'us-west-1'. Can use any region for local testing  --host HOST           Host of local DynamoDB. This parameter initialises dynamodump for local DynamoDB testing [required only for local]  --port PORT           Port of local DynamoDB [required only for local]  --accessKey ACCESSKEY                        Access key of local DynamoDB [required only for local]  --secretKey SECRETKEY                        Secret key of local DynamoDB [required only for local]  -p PROFILE, --profile PROFILE                        AWS credentials file profile to use. Allows you to use a profile instead accessKey, secretKey authentication  -s SRCTABLE, --srcTable SRCTABLE                        Source DynamoDB table name to backup or restore from, use 'tablename*' for wildcard prefix selection or '*' for all tables. Mutually exclusive with --tag  -d DESTTABLE, --destTable DESTTABLE                        Destination DynamoDB table name to backup or restore to, use 'tablename*' for wildcard prefix selection (defaults to use '-' separator) [optional, defaults to source]  --prefixSeparator PREFIXSEPARATOR                        Specify a different prefix separator, e.g. '.' [optional]  --noSeparator         Overrides the use of a prefix separator for backup wildcard searches [optional]  --readCapacity READCAPACITY                        Change the temp read capacity of the DynamoDB table to backup from [optional]  -t TAG, --tag TAG     Tag to use for identifying tables to back up. Mutually exclusive with srcTable. Provided as KEY=VALUE  --writeCapacity WRITECAPACITY                        Change the temp write capacity of the DynamoDB table to restore to [defaults to 25, optional]  --schemaOnly          Backup or restore the schema only. Do not backup/restore data. Can be used with both backup and restore modes. Cannot be used with the --dataOnly [optional]  --dataOnly            Restore data only. Do not delete/recreate schema [optional for restore]  --noConfirm           Don't ask for confirmation before deleting existing schemas.  --skipThroughputUpdate                        Skip updating throughput values across tables [optional]  --dumpPath DUMPPATH   Directory to place and search for DynamoDB table backups (defaults to use 'dump') [optional]  --billingMode {PROVISIONED,PAY_PER_REQUEST}                        Set billing mode between PROVISIONED|PAY_PER_REQUEST (defaults to use 'PROVISIONED') [optional]  --log LOG             Logging level - DEBUG|INFO|WARNING|ERROR|CRITICAL [optional]  --limit LIMIT         Limit option for backup, will stop the back up process after number of backed up items reaches the limit [optional]  -f FILTEROPTION, --filterOption FILTEROPTION                        Filter option for backup, JSON file of which keys are ['FilterExpression', 'ExpressionAttributeNames', 'ExpressionAttributeValues']

Script (unattended) usage

Docker CLI usage

docker run --rm -it bchew/dynamodump -h

public.ecr.aws/bchew/dynamodumpghcr.io/bchew/dynamodump

AWS example

dynamodump -m backup -r us-west-1 -s testTabledynamodump -m restore -r us-west-1 -s testTable

dynamodump -m backup -r us-west-1 -s production*dynamodump -m restore -r us-west-1 -s production*

dynamodump -m backup -r us-west-1 -s production*dynamodump -m restore -r us-west-1 -s production* -d development*

dynamodump -m backup -r us-west-1 -s "*"dynamodump -m restore -r us-west-1 -s "*" --dataOnly

dynamodump -m backup -r us-west-1 -p source_credentials -s "*" --schemaOnlydynamodump -m restore -r us-west-1 -p destination_credentials -s "*" --schemaOnly

dynamodump -p profile -r us-east-1 -m backup -t KEY=VALUE

dynamodump -p profile -r us-east-1 -m backup -a tar -b some_s3_bucket -t TAG_KEY=TAG_VALUEdynamodump -p profile -r us-east-1 -m backup -a zip -b some_s3_bucket -t TAG_KEY=TAG_VALUE

## source_table identifies archive file in S3 bucket from which backup data is restoreddynamodump -a tar -b some_s3_bucket -m restore -r us-east-1 -p profile -d destination_table -s source_table

Local example

dynamodump -m backup -r local -s testTable --host localhost --port 8000 --accessKey a --secretKey adynamodump -m restore -r local -s testTable --host localhost --port 8000 --accessKey a --secretKey a

Development

python3 -m venv envsource env/bin/activate# install dev requirementspip3 install -r requirements-dev.txt# one-time install of pre-commit hookspre-commit install