DynamoDB-Toolshack

Official actions to synchronize code from DynamoDB-Toolbox and DynamoDB-Toolshack.

Installation

1# npm
2npm add dynamodb-toolshack
3
4# yarn
5npm add dynamodb-toolshack
6
7# pnpm
8pnpm add dynamodb-toolshack

Note that DynamoDB-Toolbox is required as a peer dependency.

Synchronizer

The Synchronizer is a DynamoDB-Toolbox Table Action to synchronize a Table and its Entities to DynamoDB-Toolshack:

1import { Synchronizer } from 'dynamodb-toolshack'
2
3await MyTable.build(Synchronizer)
4  .entities(MyEntity, AnotherEntity, ...)
5  // 👇 AWS Config (required)
6  .awsConfig({
7    awsAccountId: '398259209128', // AWS AccountId
8    awsRegion: 'us-east-1' // AWS Region
9  })
10  // 👇 Assign an access role (optional)
11  .accessRole({
12    roleName: 'DynamoDBToolshackAccountAccessRole',
13    description: 'Optional role description'
14  })
15  // 👇 Choose DynamoDB-Toolshack metadata (optional)
16  .metadata({
17    awsAccountTitle: 'Dev',
18    // 👇 https://ui.shadcn.com/colors
19    awsAccountColor: 'blue',
20    awsAccountDescription: 'Account for development purposes',
21    // 👇 https://lucide.dev/icons/
22    tableIcon: 'database-zap',
23    tableTitle: 'Super Table',
24    tableDescription: 'An Awesome Table for development use',
25    entities: {
26      [MyEntity.name]: {
27        // 👇 https://lucide.dev/icons/
28        entityIcon: 'cat',
29        entityTitle: 'Super Entity',
30        entityDescription: 'An Awesome Entity for development use'
31      },
32      ...
33    }
34  })
35  .sync({
36    // 👇 https://app.dynamodb-toolshack.com/api-keys
37    apiKey: '<API_KEY>',
38    // 👇 Keep only specified entities for the Table (optional, `false` by default)
39    deleteUnknownEntities: true,
40    // 👇 Override Table instance name (optional)
41    tableName: 'my-table-name'
42  })

Please read the Reference for more details on the DynamoDB-Toolshack API.