https://github.com/cdklabs/cdk-dynamo-table-viewer

A CDK construct which exposes an endpoint with the contents of a DynamoDB table
https://github.com/cdklabs/cdk-dynamo-table-viewer

Last synced: about 2 months ago
JSON representation

A CDK construct which exposes an endpoint with the contents of a DynamoDB table

• Host: GitHub
• URL: https://github.com/cdklabs/cdk-dynamo-table-viewer
• Owner: cdklabs
• License: apache-2.0
• Created: 2018-10-18T13:49:50.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T00:14:33.000Z (5 months ago)
• Last Synced: 2024-04-13T23:16:44.327Z (5 months ago)
• Language: TypeScript
• Size: 4.77 MB
• Stars: 121
• Watchers: 16
• Forks: 25
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cdk-dynamo-table-viewer

An AWS CDK construct which exposes a public HTTP endpoint which displays an HTML

page with the contents of a DynamoDB table in your stack.

__SECURITY NOTE__: this construct was built for demonstration purposes and

using it in production is probably a really bad idea. It exposes the entire

contents of a DynamoDB table in your account to the general public.

The library is published under the following names:

|Language|Repository

|--------|-----------

|JavaScript/TypeScript|[cdk-dynamo-table-viewer](https://www.npmjs.com/package/cdk-dynamo-table-viewer)

|Python|[cdk-dynamo-table-viewer](https://pypi.org/project/cdk-dynamo-table-viewer/)

|.NET|[Eladb.DynamoTableViewer](https://www.nuget.org/packages/Eladb.DynamoTableViewer/)

|Java|[com.github.eladb/cdk-dynamo-table-viewer](https://search.maven.org/artifact/com.github.eladb/cdk-dynamo-table-viewer)

|Go|[github.com/cdklabs/cdk-dynamo-table-viewer-go/dynamotableviewer](https://pkg.go.dev/github.com/cdklabs/cdk-dynamo-table-viewer-go/dynamotableviewer)

## Usage (TypeScript/JavaScript)

Install via npm:

```shell

$ npm i cdk-dynamo-table-viewer

```

Add to your CDK stack:

```ts

declare const cookiesTable: dynamodb.Table;

const viewer = new TableViewer(this, 'CookiesViewer', {

  table: cookiesTable,

  title: 'Cookie Sales', // optional

  sortBy: '-sales'       // optional ("-" denotes descending order)

});

```

Notes:

- The endpoint will be available (as an deploy-time value) under `viewer.endpoint`.

  It will also be exported as a stack output.

- Paging is not supported. This means that only the first 1MB of items will be

  displayed (again, this is a demo...)

- Supports CDK version 2.60.0 and above

## License

Apache 2.0