{ "info": { "author": "Richard Boyd", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "# Amazon DocumentDB Demo Construct\n---\n\n### Installing\n#### Pypi (Python)\n`pip install docdbdemo`\n\n#### npm (JavaScript and TypeScript)\n`npm install @richardhboyd/doc_db_lib`\n\n---\n\n### Usage\n#### Python\n```python\nfrom aws_cdk import (\n core\n)\nfrom docdbdemo import DocDbLib\n\n\nclass MyStack(core.Stack):\n\n def __init__(self, scope: core.Construct, id: str, **kwargs) -> None:\n super().__init__(scope, id, **kwargs)\n\n DocDbLib(self, \"MyDocDBClient\")\n```\n\n#### TypeScript\n```typescript\nimport cdk = require('@aws-cdk/core');\nimport docdbdemo = require('@richardhboyd/doc_db_lib');\n\nexport class DocDbClientTsStack extends cdk.Stack {\n constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {\n super(scope, id, props);\n\n new docdbdemo.DocDbLib(this, \"MyDocDBClient\");\n }\n}\n```\n---\n### Diagram\n![](https://raw.githubusercontent.com/CDK-User-Group/DocumentDBDemo/master/packages/DocumentDBDemo/diagram.png)\n\n---\n### Interacting\nDeploying the stack will create an Amazon DocumentDB Cluster with one instance in each availability zone created by the CDK's VPC Construct, a Lambda function that can put items into the database and fetch them out again, and an API to send requests to the Lambda Funciton.\n\nThe stack will output an APIGateway endpoint that will front the created DocumentDB.\n\n```bash\nOutputs:\nDocDbClientTsStack.MyDocDBClientMyDocDbApiMyDocDBApiEndpoint74609B36 = https://gv8ooq7zti.execute-api.us-east-1.amazonaws.com/prod/\n\n```\n\nLet's look at how we use this new API.\n\nPutting a document in the DocumentDB\n```bash\nAPI=https://gv8ooq7zti.execute-api.us-east-1.amazonaws.com/prod\ncurl -H \"Content-Type: application/json\" -d '{\"bestCoder\":\"@allenmichael\", \"worstCoder\":\"singledigit\"}' -X POST $API/document\n```\n\nGetting a document out of the database\n```bash\nAPI=https://gv8ooq7zti.execute-api.us-east-1.amazonaws.com/prod\ncurl -H \"Content-Type: application/json\" $API/document?bestCoder=@allenmichael\n```\n\nTesting this out we see\n```bash\n$ curl -H \"Content-Type: application/json\" -d '{\"bestCoder\":\"@allenmichael\", \"worstCoder\":\"@singledigit\"}' -X POST $API/document\n\n{\"id\": \"5d7bd032c7866a33171a1261\"}\n\n$ curl -H \"Content-Type: application/json\" $API/document?bestCoder=@allenmichael\n\n{'_id': ObjectId('5d7bcfe6c7866a33171a125f'), 'bestCoder': '@allenmichael', 'worstCoder': '@singledigit'}\n```\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/CDK-User-Group/DocumentDBDemo", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "docdbdemo", "package_url": "https://pypi.org/project/docdbdemo/", "platform": "", "project_url": "https://pypi.org/project/docdbdemo/", "project_urls": { "Homepage": "https://github.com/CDK-User-Group/DocumentDBDemo", "Source": "https://github.com/CDK-User-Group/DocumentDBDemo" }, "release_url": "https://pypi.org/project/docdbdemo/0.1.0a6/", "requires_dist": [ "jsii (~=0.15.2)", "publication (>=0.0.3)", "aws-cdk.aws-apigateway (>=1.8.0,~=1.8)", "aws-cdk.aws-docdb (>=1.8.0,~=1.8)", "aws-cdk.aws-ec2 (>=1.8.0,~=1.8)", "aws-cdk.aws-lambda (>=1.8.0,~=1.8)", "aws-cdk.aws-secretsmanager (>=1.8.0,~=1.8)", "aws-cdk.core (>=1.8.0,~=1.8)" ], "requires_python": ">=3.6", "summary": "DocumentDB API Example", "version": "0.1.0a6" }, "last_serial": 5827060, "releases": { "0.1.0a1": [ { "comment_text": "", "digests": { "md5": "7e7257953bb1d4c19f60cd0fd122a13f", "sha256": "737921c3db2adbe5f69043900143806ea4a4cda0fee3dfe0eb10c3649a774569" }, "downloads": -1, "filename": "docdbdemo-0.1.0a1-py3-none-any.whl", "has_sig": false, "md5_digest": "7e7257953bb1d4c19f60cd0fd122a13f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 11503, "upload_time": "2019-09-13T04:43:20", "url": "https://files.pythonhosted.org/packages/64/a8/4881ee5ec75205e845437a03299b9745e9262cf1b2abce26f764240a707d/docdbdemo-0.1.0a1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5b5a22cb249e4dee41f396b1e0e3aeb2", "sha256": "c6e6e4eee2d209dbfc4b1d45957cc05e535fc18211e1630fce20650381ddc7c6" }, "downloads": -1, "filename": "docdbdemo-0.1.0a1.tar.gz", "has_sig": false, "md5_digest": "5b5a22cb249e4dee41f396b1e0e3aeb2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 11298, "upload_time": "2019-09-13T04:43:22", "url": "https://files.pythonhosted.org/packages/5b/45/a9416764c18c67fc5267f47eeb9be71c7bda4fd3b86daf9e52f262192c72/docdbdemo-0.1.0a1.tar.gz" } ], "0.1.0a2": [ { "comment_text": "", "digests": { "md5": "cd908ea31ef57a1dfee557b54f93b0d9", "sha256": "ca17a49ec3388de31b7aebb44a2b758a86fc50504cd5c962891ba7d1e4b2ca83" }, "downloads": -1, "filename": "docdbdemo-0.1.0a2-py3-none-any.whl", "has_sig": false, "md5_digest": "cd908ea31ef57a1dfee557b54f93b0d9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 696380, "upload_time": "2019-09-13T05:07:49", "url": "https://files.pythonhosted.org/packages/4c/dd/729c6656a4b4dc1d28b03a4dd850a6fcbf968c094f831faaf032bd4a2802/docdbdemo-0.1.0a2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "064fa3fb55cbc7faa02eb539f84d3b68", "sha256": "4d969bc082f33aac3044dfd43585140459e5bce1451fdcb2700095ee4a07bfb5" }, "downloads": -1, "filename": "docdbdemo-0.1.0a2.tar.gz", "has_sig": false, "md5_digest": "064fa3fb55cbc7faa02eb539f84d3b68", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 696744, "upload_time": "2019-09-13T05:07:50", "url": "https://files.pythonhosted.org/packages/dc/8b/667ab60b8187740028de85bc9904f128bd78d860f2ee07bcfa5ab25b7070/docdbdemo-0.1.0a2.tar.gz" } ], "0.1.0a3": [ { "comment_text": "", "digests": { "md5": "e094c0a37215bdacc078bcc629fad1af", "sha256": "84f7479ec5d501b6ed88ae2ccb3cc5201a94839679eee18462e266c9664de9c0" }, "downloads": -1, "filename": "docdbdemo-0.1.0a3-py3-none-any.whl", "has_sig": false, "md5_digest": "e094c0a37215bdacc078bcc629fad1af", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 696465, "upload_time": "2019-09-13T14:54:28", "url": "https://files.pythonhosted.org/packages/ea/0c/160b6aca5c4509a334d1236e36d1e93bbf065ef4b6c5ffc90e2dce610193/docdbdemo-0.1.0a3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b02fff3e43cada42f26b03c4311c1fdf", "sha256": "5aa501c31631a9e13fd6510d8e3fe367df01e1e333b86fe313208759e8d70702" }, "downloads": -1, "filename": "docdbdemo-0.1.0a3.tar.gz", "has_sig": false, "md5_digest": "b02fff3e43cada42f26b03c4311c1fdf", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 696884, "upload_time": "2019-09-13T14:54:30", "url": "https://files.pythonhosted.org/packages/09/06/438105786f05abb344a05e97e7b92aca38a9cfe2ffc67014bfe815510552/docdbdemo-0.1.0a3.tar.gz" } ], "0.1.0a4": [ { "comment_text": "", "digests": { "md5": "25746ee3fcf96f7456341ed4629b4a1c", "sha256": "06e4e2ae1bc0d4c119148032a45faa7b0f11868f39c6bcfd59e6ac184bd64f24" }, "downloads": -1, "filename": "docdbdemo-0.1.0a4-py3-none-any.whl", "has_sig": false, "md5_digest": "25746ee3fcf96f7456341ed4629b4a1c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 749160, "upload_time": "2019-09-13T17:30:06", "url": "https://files.pythonhosted.org/packages/9b/bf/22afd19ffe1f53a30fb5184173714312c78444e664463ad40611ccb6a379/docdbdemo-0.1.0a4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6fbc0166c1ad6c283e950394ce730741", "sha256": "a158d6c6960e7743b1bec9fa389599d9c6c207304283c6cfbd9b45badcb74d54" }, "downloads": -1, "filename": "docdbdemo-0.1.0a4.tar.gz", "has_sig": false, "md5_digest": "6fbc0166c1ad6c283e950394ce730741", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 750982, "upload_time": "2019-09-13T17:30:08", "url": "https://files.pythonhosted.org/packages/89/b4/2f14fbf29a5d41958eedc54933a6baf297466676fa83109a9205168f1a78/docdbdemo-0.1.0a4.tar.gz" } ], "0.1.0a5": [ { "comment_text": "", "digests": { "md5": "a1879d3f808cbd3c2bd5d962b58db03b", "sha256": "cf9bc9c02838a2cd61eb96c24eb3e5cfa1cf976068ae58d2138cd6221aaaa0af" }, "downloads": -1, "filename": "docdbdemo-0.1.0a5-py3-none-any.whl", "has_sig": false, "md5_digest": "a1879d3f808cbd3c2bd5d962b58db03b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 749133, "upload_time": "2019-09-13T17:36:10", "url": "https://files.pythonhosted.org/packages/88/89/8633f7fa3cdff77f7b3d9f867704faa96ea08afa16f45b6c7b6938817f61/docdbdemo-0.1.0a5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1d5e24d3eb7f58fd0046dd9dd58615e1", "sha256": "756a2839d6212f1140b08b362c7254009dd2bdd938a6fe0a6bfd6cf21e40b111" }, "downloads": -1, "filename": "docdbdemo-0.1.0a5.tar.gz", "has_sig": false, "md5_digest": "1d5e24d3eb7f58fd0046dd9dd58615e1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 750961, "upload_time": "2019-09-13T17:36:12", "url": "https://files.pythonhosted.org/packages/bd/59/5548dcd3e4c1d23311dad0774d23dfc128f049ddff7b92afcff751347f4a/docdbdemo-0.1.0a5.tar.gz" } ], "0.1.0a6": [ { "comment_text": "", "digests": { "md5": "2d6e1423496a188d0dfc2b56238eb422", "sha256": "923a0e4cc4284c607caf45750eb1c5b983556692ce5ba513931b7e7e21064c80" }, "downloads": -1, "filename": "docdbdemo-0.1.0a6-py3-none-any.whl", "has_sig": false, "md5_digest": "2d6e1423496a188d0dfc2b56238eb422", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 749202, "upload_time": "2019-09-13T17:52:17", "url": "https://files.pythonhosted.org/packages/53/8b/dbe512101a2064c47d56d601f70c3fb8716bd2666469ccc8ac088a84e221/docdbdemo-0.1.0a6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ece8be596a06f81bb83744db57036560", "sha256": "27ef93cb0ee4820d7a4404a0073ab0ef23ccd628def4d8f9b17991d052288cb5" }, "downloads": -1, "filename": "docdbdemo-0.1.0a6.tar.gz", "has_sig": false, "md5_digest": "ece8be596a06f81bb83744db57036560", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 751046, "upload_time": "2019-09-13T17:52:19", "url": "https://files.pythonhosted.org/packages/6b/7f/b746dfdd5a38efce506149dee79ac96fe625b025c50469c0ce132d57e9c2/docdbdemo-0.1.0a6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2d6e1423496a188d0dfc2b56238eb422", "sha256": "923a0e4cc4284c607caf45750eb1c5b983556692ce5ba513931b7e7e21064c80" }, "downloads": -1, "filename": "docdbdemo-0.1.0a6-py3-none-any.whl", "has_sig": false, "md5_digest": "2d6e1423496a188d0dfc2b56238eb422", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 749202, "upload_time": "2019-09-13T17:52:17", "url": "https://files.pythonhosted.org/packages/53/8b/dbe512101a2064c47d56d601f70c3fb8716bd2666469ccc8ac088a84e221/docdbdemo-0.1.0a6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ece8be596a06f81bb83744db57036560", "sha256": "27ef93cb0ee4820d7a4404a0073ab0ef23ccd628def4d8f9b17991d052288cb5" }, "downloads": -1, "filename": "docdbdemo-0.1.0a6.tar.gz", "has_sig": false, "md5_digest": "ece8be596a06f81bb83744db57036560", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 751046, "upload_time": "2019-09-13T17:52:19", "url": "https://files.pythonhosted.org/packages/6b/7f/b746dfdd5a38efce506149dee79ac96fe625b025c50469c0ce132d57e9c2/docdbdemo-0.1.0a6.tar.gz" } ] }