Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions docs/modules/dynamodb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# DynamoDB

## Install

```bash
npm install @testcontainers/dynamodb --save-dev
```

## Examples

These examples use the following libraries:

- [@aws-sdk/client-dynamodb](https://www.npmjs.com/package/@aws-sdk/client-dynamodb)

npm install @aws-sdk/client-dynamodb

Choose an image from the [container registry](https://hub.docker.com/r/amazon/dynamodb-local) and substitute `IMAGE`.

### Connect to local endpoint

In order to use a DynamoDB Client we have to specify
at least `region`, `credentials` and `endpoint` eventhough `region` and `credentials`
will not be used:

<!--codeinclude-->
[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectEndpoint
<!--/codeinclude-->

### Connect via client config

The above can also be written as

<!--codeinclude-->
[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:connectClientConfig
<!--/codeinclude-->

### Use a shared database

<!--codeinclude-->
[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:sharedDB
<!--/codeinclude-->

### Disable telemetry

<!--codeinclude-->
[](../../packages/modules/dynamodb/src/dynamodb-container.test.ts) inside_block:disabledTelemetry
<!--/codeinclude-->
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ nav:
- CosmosDB: modules/cosmosdb.md
- Couchbase: modules/couchbase.md
- CouchDB: modules/couchdb.md
- DynamoDB: modules/dynamodb.md
- Elasticsearch: modules/elasticsearch.md
- Etcd: modules/etcd.md
- GCloud: modules/gcloud.md
Expand Down
Loading