A simple CDK JSON seeder for DynamoDB
Why this package
Glad you asked!
Using AWS CDK for automating infrastructure deployments is an amazing way of integrating the development and operations into one process and one codebase.
However, building dev or test environments that come pre-populated with data can be tricky, especially when using Amazon DynamoDB.
How do I use it
Install using your favourite package manager:
yarn add aws-cdk-dynamodb-seeder
Example TypeScript usage
;...;...new Seederstack, "MySeeder",;
For a more in-depth example, see: elegantdevelopment/aws-cdk-dynamodb-seeder-examples.
Importing seed data
Data passed into
setup ("Items" to put) or
teardown ("Keys" to delete) should be an
array of objects (that are, in turn, representations of
string to AttributeValue maps).
setupelements should use the format of
teardownelements should use the format of
We will attempt to align the major and minor version of this package with AWS CDK, but always check our release descriptions for compatibility.
Deploying a stack
We then create the handler function and custom resource to field seed requests (the
onCreate event will immediate fire as the stack deploys, reading the data from the bucket and seeding the table using AWS.DynamoDB.DocumentClient).
Updating a stack
On a stack update, the
onUpdate handler is triggered when
Destroying a stack
When the stack is destroyed, the event handler's
onDelete function will be invoked, providing
teardown is set.
This simply runs AWS.DynamoDB.DocumentClient.delete() on every teardown "Key" before destroying the