Skip to content

Commit

Permalink
doc(iot): README
Browse files Browse the repository at this point in the history
  • Loading branch information
yamatatsu committed Oct 6, 2021
1 parent be225a8 commit 7379534
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions packages/@aws-cdk/aws-iot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ new TopicRule(stack, 'MyTopicRule', {
});
```

### Set state of an Amazon CloudWatch alarm
### Add action to set state of an Amazon CloudWatch alarm

```ts
topicRule.addAction(
Expand All @@ -93,13 +93,13 @@ topicRule.addAction(
);
```

### Send data to Amazon CloudWatch Logs
### Add action to send data to Amazon CloudWatch Logs

```ts
topicRule.addAction(new iot.CloudwatchLogsAction(logGroup));
```

### Capture an Amazon CloudWatch metric
### Add action to capture an Amazon CloudWatch metric

```ts
topicRule.addAction(new iot.CloudwatchMetricAction({
Expand All @@ -111,7 +111,7 @@ topicRule.addAction(new iot.CloudwatchMetricAction({
}));
```

### Write all or part of an MQTT message to an Amazon DynamoDB table
### Add action to write all or part of an MQTT message to an Amazon DynamoDB table

```ts
topicRule.addAction(new iot.DynamoDBAction({
Expand All @@ -130,31 +130,31 @@ topicRule.addAction(new iot.DynamoDBv2Action(table));

Dynamodb v2 action is easy to use, but only v1 action supports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html).

### Invoke an AWS Lambda function, passing in an MQTT message
### Add action to invoke an AWS Lambda function, passing in an MQTT message

```ts
topicRule.addAction(new actions.LambdaAction(lambdaFn));
```

### Republish an MQTT message to another MQTT topic
### Add action to republish an MQTT message to another MQTT topic

```ts
topicRule.addAction(new iot.RepublishAction('test-topic'));
```

### Write the data from an MQTT message to an Amazon S3 bucket
### Add action to write the data from an MQTT message to an Amazon S3 bucket

```ts
topicRule.addAction(new iot.S3Action(bucket));
```

### Send the data from an MQTT message as an Amazon SNS push notification
### Add action to send the data from an MQTT message as an Amazon SNS push notification

```ts
topicRule.addAction(new iot.SnsAction(topic));
```

### Send data from an MQTT message to an Amazon SQS queue
### Add action to send data from an MQTT message to an Amazon SQS queue

```ts
topicRule.addAction(new iot.SqsAction(queue));
Expand Down

0 comments on commit 7379534

Please sign in to comment.