{"id":21377211,"url":"https://github.com/softchef/cdk-iot-device-management","last_synced_at":"2025-07-13T10:31:24.292Z","repository":{"id":37357189,"uuid":"373116929","full_name":"SoftChef/cdk-iot-device-management","owner":"SoftChef","description":null,"archived":false,"fork":false,"pushed_at":"2022-08-09T02:52:09.000Z","size":3817,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-27T20:43:21.530Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SoftChef.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-02T09:54:08.000Z","updated_at":"2023-03-06T20:21:47.000Z","dependencies_parsed_at":"2022-07-12T13:00:39.485Z","dependency_job_id":null,"html_url":"https://github.com/SoftChef/cdk-iot-device-management","commit_stats":null,"previous_names":[],"tags_count":120,"template":false,"template_full_name":null,"purl":"pkg:github/SoftChef/cdk-iot-device-management","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fcdk-iot-device-management","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fcdk-iot-device-management/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fcdk-iot-device-management/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fcdk-iot-device-management/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SoftChef","download_url":"https://codeload.github.com/SoftChef/cdk-iot-device-management/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fcdk-iot-device-management/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265128233,"owners_count":23715621,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T09:19:35.834Z","updated_at":"2025-07-13T10:31:23.993Z","avatar_url":"https://github.com/SoftChef.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/%40softchef%2Fcdk-iot-device-management.svg)](https://badge.fury.io/js/%40softchef%2Fcdk-iot-device-management)\n![Release](https://github.com/SoftChef/cdk-iot-device-management/workflows/Release/badge.svg)\n![npm](https://img.shields.io/npm/dt/@softchef/cdk-iot-device-management?label=NPM%20Downloads\u0026color=orange)\n\n# CDK Construct - IoT Device Management\n\nIoT device management is composed of things, thing types, thing groups, jobs, files API services. The constructs can be used independently, that are based on full-managed service to create an API Gateway \u0026 Lambda function.\n\n![Architecture](docs/cdk-iot-device-management.png)\n\n## Installation\n\n```sh\nnpm install @softchef/cdk-iot-device-management\n\nor\n\nyarn add @softchef/cdk-iot-device-management\n\n```\n\n## Why\n\n- Integrate RestAPI and AWS IoT core to implement access control.\n- Manage device firmware information.\n- Manage device, such as create an OTA jobs.\n\nThis construct library provides five constructs:\n\n- **Thing Type API construct** - Create and modify thing types' information.\n- **Thing API construct** - Create and modify things' information.\n- **Thing Group construct** - Create and modify thing groups' information.\n- **Job API construct** - Create and modify thing's jobs.\n- **File API construct** - Integrate API Gateway and DynamoDB to store device firmware information.\n\n## Constructs\n\n### Thing Type API construct\n\nUse thing type API to manage thing types.\n\n```typescript\nimport { ThingTypeApi } from '@softchef/cdk-iot-device-management'\n\nconst thingTypeApi = new ThingTypeApi(scope, id, {\n  authorizationType?: apigateway.AuthorizationType;\n  authorizer?: apigateway.IAuthorizer\n})\n```\n\n[Thing Type API Docs](./docs/thing-type-api.md)\n\n### Thing API construct\n\nUse thing API to manage things' information.\n\n```typescript\nimport { ThingApi } from '@softchef/cdk-iot-device-management'\n\nconst thingApi = new ThingApi(scope, id, {\n  authorizationType?: apigateway.AuthorizationType;\n  authorizer?: apigateway.IAuthorizer\n})\n```\n\n[Thing API Docs](./docs/thing-api.md)\n\n### Thing Group API construct\n\nUse thing API to manage thing groups' information.\n\n```typescript\nimport { ThingGroupApi } from '@softchef/cdk-iot-device-management'\n\nconst thingGroupApi = new ThingGroupApi(scope, id, {\n  authorizationType?: apigateway.AuthorizationType;\n  authorizer?: apigateway.IAuthorizer\n})\n```\n\n[Thing Group API Docs](./docs/thing-group-api.md)\n\n### Job API construct\n\nUse job API to manage jobs' information.\n\n```typescript\nimport { JobApi } from '@softchef/cdk-iot-device-management'\n\nconst jobApi = new JobApi(scope, id, {\n  authorizationType?: apigateway.AuthorizationType;\n  authorizer?: apigateway.IAuthorizer;\n  scheduleFunction: ScheduleFunction\n})\n```\n\n\u003e The [ScheduleFunction](https://www.npmjs.com/package/@softchef/cdk-schedule-function/v/0.0.15) is support to custom create job by schedule time.\n\n[Job API Docs](./docs/job-api.md)\n\n### File API construct\n\nUse File API to manage IoT devices firmware. File API contains category and file.\n\n```typescript\nimport { fileApi } from '@softchef/cdk-iot-device-management'\n\nconst FileApi = new FileApi(scope, id, {\n  authorizationType?: apigateway.AuthorizationType;\n  authorizer?: apigateway.IAuthorizer;\n})\n```\n\n[File API Docs](./docs/file-api.md)\n\n### Category Table Schema\n\n| Name        | Schema | Primary Index | GSI(Query By ParentId) |\n| ----------- | ------ | ------------- | ---------------------- |\n| categoryId  | String | Partition Key |                        |\n| parentId    | String |               | Partition Key          |\n| name        | String |               |                        |\n| description | String |               |                        |\n\n### File Table Schema\n\n| Name         | Schema | Primary Index | GSI(Query By CategoryId And Locale) | GSI(Get File By Checksum And Version) |\n| ------------ | ------ | ------------- | ----------------------------------- | ------------------------------------- |\n| fileId       | String | Partition Key |                                     |                                       |\n| categoryId   | String |               | Partition Key                       |                                       |\n| checksum     | String |               |                                     | Partition Key                         |\n| version      | String |               |                                     | Sort Key                              |\n| checksumType | String |               |                                     |                                       |\n| location     | String |               |                                     |                                       |\n| locale       | String |               | Sort Key                            |                                       |\n| summary      | String |               |                                     |                                       |\n| description  | String |               |                                     |                                       |\n| updatedAt    | Number |               |                                     |                                       |\n| createdAt    | Number |               |                                     |                                       |\n\n## License\n\nThis code is licensed under the Apache License 2.0. See the [LICENSE](https://github.com/SoftChef/cdk-iot-device-management/blob/main/LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftchef%2Fcdk-iot-device-management","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftchef%2Fcdk-iot-device-management","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftchef%2Fcdk-iot-device-management/lists"}