Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aheissenberger/sam-dynamodb-create-table
create dynamoDB tables based on an existing sam template.yaml file
https://github.com/aheissenberger/sam-dynamodb-create-table
aws command-line dynamodb
Last synced: 2 months ago
JSON representation
create dynamoDB tables based on an existing sam template.yaml file
- Host: GitHub
- URL: https://github.com/aheissenberger/sam-dynamodb-create-table
- Owner: aheissenberger
- License: mit
- Created: 2020-09-27T11:41:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T20:35:46.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T05:11:54.020Z (3 months ago)
- Topics: aws, command-line, dynamodb
- Language: JavaScript
- Homepage:
- Size: 50.8 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Create AWS dynamoDB Tables
CLI tool to create AWS dynamoDB tables from a [AWS SAM](https://aws.amazon.com/de/serverless/sam/) (AWS Serverless Application Model) template.yaml file. This allows to use a local dynamoDB (e.g. [dynamodb-local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) or [dynalite](https://github.com/mhart/dynalite)) for local development.
If the Table exists it will fail with `ERROR: ResourceInUseException`.
## Quick Start
if you locally started dynamodb on port 8000:
`npx sam-dynamodb-create-table -e http://localhost:8000 -f template.yaml`
## Install
*global install*
`npm i -g sam-dynamodb-create-table`
prefered way to use is without installation with `npx`!
## Usage
`sam-dynamodb-create-table --help`
```
Usage: sam-dynamodb-create-table [options]
Options:
-d, --debug output extra debugging information
-c, --configuration configuration file - format JSON
-f, --file sam template.yaml (default: template.yaml)
-e, --endpoint dynamoDB endpoint url (default: http://localhost:8000)
-r, --region AWS region (default: us-east-1)
--config-template output JSON config template (default: false)
--table-name Table name if not provided by the template.yml or template.json
-h, --help display help for command
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning.
## Changes
* **2023-04-18
- upgrade to AWS-SDK Version 3
- add support for Cloudformation files
- add some transformations to fix errors when deployed to a local dynamoDB server
- fix: set ProvisionedThroughput to 1/1
- fix: set GlobalSecondaryIndexes / ProvisionedThroughput to 1/1
- fix: convert GlobalSecondaryIndexes.Projection from string to object
## Authors
* **Andreas Heissenberger** - *Initial work* - [Github](https://github.com/aheissenberger) | [Heissenberger Laboratory](https://www.heissenberger.at)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details