cdk-dynamo-table-view


Namecdk-dynamo-table-view JSON
Version 0.2.197 PyPI version JSON
download
home_pagehttps://github.com/cdklabs/cdk-dynamo-table-viewer.git
SummaryAn AWS CDK construct which exposes an endpoint with the contents of a DynamoDB table
upload_time2022-07-03 00:35:01
maintainer
docs_urlNone
authorElad Ben-Israel<elad.benisrael@gmail.com>
requires_python~=3.7
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)

## Usage (TypeScript/JavaScript)

Install via npm:

```shell
$ npm i cdk-dynamo-table-viewer
```

Add to your CDK stack:

```python
import { TableViewer } from 'cdk-dynamo-table-viewer'

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 0.38.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": "Elad Ben-Israel<elad.benisrael@gmail.com>",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/57/72/2dc76a607dd15a525d106392d3a7a09f22eb01dd99c31ff6f3f9fca05abd/cdk-dynamo-table-view-0.2.197.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\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\nimport { TableViewer } from 'cdk-dynamo-table-viewer'\n\nconst viewer = new TableViewer(this, 'CookiesViewer', {\n  table: cookiesTable,\n  title: 'Cookie Sales', // optional\n  sortBy: '-sales'       // optional (\"-\" denotes descending order)\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 0.38.0 and above\n\n## License\n\nApache 2.0\n\n\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.197",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "3b0bc58c0b3349d8b487b83687cf07df",
                "sha256": "44bc07c1bb33b4652473f2d718a6d28fc078a7b7c3c29091a969fb600f275169"
            },
            "downloads": -1,
            "filename": "cdk_dynamo_table_view-0.2.197-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b0bc58c0b3349d8b487b83687cf07df",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.7",
            "size": 28950,
            "upload_time": "2022-07-03T00:34:59",
            "upload_time_iso_8601": "2022-07-03T00:34:59.643028Z",
            "url": "https://files.pythonhosted.org/packages/5b/6c/d6d33b3b8931f9551ab3c13cc2df1c7506a4770057bac1ab68c187026851/cdk_dynamo_table_view-0.2.197-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f1ba0159c2516a7d1ad19ce9234d1228",
                "sha256": "8fabb596c116c3b44b84265b80b24f4b862603e0c0a49b8e769f5702beaa8749"
            },
            "downloads": -1,
            "filename": "cdk-dynamo-table-view-0.2.197.tar.gz",
            "has_sig": false,
            "md5_digest": "f1ba0159c2516a7d1ad19ce9234d1228",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.7",
            "size": 30165,
            "upload_time": "2022-07-03T00:35:01",
            "upload_time_iso_8601": "2022-07-03T00:35:01.876421Z",
            "url": "https://files.pythonhosted.org/packages/57/72/2dc76a607dd15a525d106392d3a7a09f22eb01dd99c31ff6f3f9fca05abd/cdk-dynamo-table-view-0.2.197.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-07-03 00:35:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "cdklabs",
    "github_project": "cdk-dynamo-table-viewer.git",
    "lcname": "cdk-dynamo-table-view"
}
        
Elapsed time: 0.53716s