Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
badmintoncryer committed Oct 24, 2024
1 parent ea97c3e commit c267cc8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

This is a CDK construct that creates an AWS IoT Core Thing with a certificate and policy using [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3).

![elements](./images/iot.png)

Cloudformation does not support creating a certificate for an IoT Thing, so this construct uses the AWS SDK to create a certificate and attach it to the Thing.

This construct is a modified version of this excellent [construct (cdk-iot-core-certificate)](https://github.com/devops-at-home/cdk-iot-core-certificates) to work with aws-sdk-js-v3.

## Installation

```bash
npm i cdk-iot-core-certificate-v3
npm i cdk-iot-core-certificates-v3
```

## Usage
Expand All @@ -18,8 +20,11 @@ npm i cdk-iot-core-certificate-v3
import { ThingWithCert } from 'cdk-iot-core-certificate-v3';

const thing = new ThingWithCert(this, 'MyThing', {
// The name of the thing
thingName: 'MyThing',
// Whether to save the certificate and private key to the SSM Parameter Store
saveToParamStore: true,
// The prefix to use for the SSM Parameter Store parameters
paramPrefix: 'test',
});

Expand Down
Binary file added images/iot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c267cc8

Please sign in to comment.