# 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:
```python
# cookies_table: dynamodb.Table
viewer = TableViewer(self, "CookiesViewer",
table=cookies_table,
title="Cookie Sales", # optional
sort_by="-sales"
)
```
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
Raw data
{
"_id": null,
"home_page": "https://github.com/cdklabs/cdk-dynamo-table-viewer.git",
"name": "cdk-dynamo-table-view",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services<aws-cdk-dev@amazon.com>",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/80/ba/9e54b474fb9227954f7505562c7042feb5bdd5c921a1d478d7fe00246f50/cdk-dynamo-table-view-0.2.488.tar.gz",
"platform": null,
"description": "# cdk-dynamo-table-viewer\n\nAn AWS CDK construct which exposes a public HTTP endpoint which displays an HTML\npage with the contents of a DynamoDB table in your stack.\n\n**SECURITY NOTE**: this construct was built for demonstration purposes and\nusing it in production is probably a really bad idea. It exposes the entire\ncontents of a DynamoDB table in your account to the general public.\n\nThe library is published under the following names:\n\n|Language|Repository\n|--------|-----------\n|JavaScript/TypeScript|[cdk-dynamo-table-viewer](https://www.npmjs.com/package/cdk-dynamo-table-viewer)\n|Python|[cdk-dynamo-table-viewer](https://pypi.org/project/cdk-dynamo-table-viewer/)\n|.NET|[Eladb.DynamoTableViewer](https://www.nuget.org/packages/Eladb.DynamoTableViewer/)\n|Java|[com.github.eladb/cdk-dynamo-table-viewer](https://search.maven.org/artifact/com.github.eladb/cdk-dynamo-table-viewer)\n|Go|[github.com/cdklabs/cdk-dynamo-table-viewer-go/dynamotableviewer](https://pkg.go.dev/github.com/cdklabs/cdk-dynamo-table-viewer-go/dynamotableviewer)\n\n## Usage (TypeScript/JavaScript)\n\nInstall via npm:\n\n```shell\n$ npm i cdk-dynamo-table-viewer\n```\n\nAdd to your CDK stack:\n\n```python\n# cookies_table: dynamodb.Table\n\n\nviewer = TableViewer(self, \"CookiesViewer\",\n table=cookies_table,\n title=\"Cookie Sales\", # optional\n sort_by=\"-sales\"\n)\n```\n\nNotes:\n\n* The endpoint will be available (as an deploy-time value) under `viewer.endpoint`.\n It will also be exported as a stack output.\n* Paging is not supported. This means that only the first 1MB of items will be\n displayed (again, this is a demo...)\n* Supports CDK version 2.60.0 and above\n\n## License\n\nApache 2.0\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "An AWS CDK construct which exposes an endpoint with the contents of a DynamoDB table",
"version": "0.2.488",
"project_urls": {
"Homepage": "https://github.com/cdklabs/cdk-dynamo-table-viewer.git",
"Source": "https://github.com/cdklabs/cdk-dynamo-table-viewer.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2dcd1271cff02026e9a8a9e2d75ae8a8ec4e209fd149402653e9617070e03913",
"md5": "43ad419b123f73a84c8633345f1f1297",
"sha256": "1bf4fcfa28c889e5e9f5fb0b3855ab89c3e7f3df2e8474ce91f6b09a765396be"
},
"downloads": -1,
"filename": "cdk_dynamo_table_view-0.2.488-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43ad419b123f73a84c8633345f1f1297",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 31992,
"upload_time": "2023-11-16T18:17:30",
"upload_time_iso_8601": "2023-11-16T18:17:30.364617Z",
"url": "https://files.pythonhosted.org/packages/2d/cd/1271cff02026e9a8a9e2d75ae8a8ec4e209fd149402653e9617070e03913/cdk_dynamo_table_view-0.2.488-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "80ba9e54b474fb9227954f7505562c7042feb5bdd5c921a1d478d7fe00246f50",
"md5": "14230d37e29a4cfafc37652bd61dada0",
"sha256": "20256c9f513cb0e7c6c15387b3a7cbcb4d586f0ffffaab6cdabb56559c569efd"
},
"downloads": -1,
"filename": "cdk-dynamo-table-view-0.2.488.tar.gz",
"has_sig": false,
"md5_digest": "14230d37e29a4cfafc37652bd61dada0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 33300,
"upload_time": "2023-11-16T18:17:34",
"upload_time_iso_8601": "2023-11-16T18:17:34.921118Z",
"url": "https://files.pythonhosted.org/packages/80/ba/9e54b474fb9227954f7505562c7042feb5bdd5c921a1d478d7fe00246f50/cdk-dynamo-table-view-0.2.488.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-16 18:17:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cdklabs",
"github_project": "cdk-dynamo-table-viewer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cdk-dynamo-table-view"
}