AWS iot-sitewise documentation change
Summary
Updated tutorial steps to consolidate procedures, added IAM documentation reference, modified notification status terminology (ENABLED->ACTIVE), integrated DynamoDB table creation into rule configuration flow, added explicit IAM role creation steps, and updated console navigation instructions.
Security assessment
The changes include adding a link to IAM documentation in prerequisites and explicit IAM role creation during rule configuration, which improves security awareness but does not address a specific vulnerability. Terminology changes (e.g., 'ENABLED' to 'ACTIVE') and procedural consolidations are operational improvements without direct security implications.
Diff
diff --git a/iot-sitewise/latest/userguide/publish-to-amazon-dynamodb.md b/iot-sitewise/latest/userguide/publish-to-amazon-dynamodb.md index d8c626dd9..8e3bc7543 100644 --- a//iot-sitewise/latest/userguide/publish-to-amazon-dynamodb.md +++ b//iot-sitewise/latest/userguide/publish-to-amazon-dynamodb.md @@ -5 +5 @@ -PrerequisitesStep 1: Configure AWS IoT SiteWise to publish property value updatesStep 2: Create a rule in AWS IoT CoreStep 3: Create a DynamoDB tableStep 4: Configure the DynamoDB rule actionStep 5: Explore data in DynamoDBStep 6: Clean up resources after the tutorial +PrerequisitesStep 1: Configure AWS IoT SiteWise to publish property value updatesStep 2: Create a rule in AWS IoT CoreStep 3: Configure the DynamoDB rule actionStep 4: Explore data in DynamoDBStep 5: Clean up resources after the tutorial @@ -21 +21 @@ In this tutorial, you build on the AWS IoT SiteWise demo that provides a sample - * Step 3: Create a DynamoDB table + * Step 3: Configure the DynamoDB rule action @@ -23 +23 @@ In this tutorial, you build on the AWS IoT SiteWise demo that provides a sample - * Step 4: Configure the DynamoDB rule action + * Step 4: Explore data in DynamoDB @@ -25,3 +25 @@ In this tutorial, you build on the AWS IoT SiteWise demo that provides a sample - * Step 5: Explore data in DynamoDB - - * Step 6: Clean up resources after the tutorial + * Step 5: Clean up resources after the tutorial @@ -40 +38 @@ To complete this tutorial, you need the following: - * An IAM user with administrator permissions. + * An IAM user with administrator permissions. For detailed instructions, see [How AWS IoT SiteWise works with IAM](./security_iam_service-with-iam.html). @@ -59,2 +56,0 @@ In this procedure, you enable property value notifications on your demo turbine - - @@ -63,2 +58,0 @@ In this procedure, you enable property value notifications on your demo turbine - - @@ -67,5 +61 @@ In this procedure, you enable property value notifications on your demo turbine - - - 6. Update the **Wind Speed** property's **Notification status** to **ENABLED**. - - + 6. Choose **Measurements**. @@ -73 +63 @@ In this procedure, you enable property value notifications on your demo turbine - 7. Choose **Save asset** at the bottom of the page. + 7. Update the **Wind Speed** property's **MQTT Notification status** to **ACTIVE**. @@ -75 +65 @@ In this procedure, you enable property value notifications on your demo turbine - 8. Repeat steps 5 through 7 for each demo turbine asset. + 8. Choose **Save** at the bottom of the page. @@ -77 +67 @@ In this procedure, you enable property value notifications on your demo turbine - 9. Choose a demo turbine (for example, **Demo Turbine Asset 1**). + 9. Repeat steps 5 through 7 for each demo turbine asset. @@ -79 +69 @@ In this procedure, you enable property value notifications on your demo turbine - 10. Choose **Measurements**. + 10. Choose a demo turbine (for example, **Demo Turbine Asset 1**). @@ -81 +71 @@ In this procedure, you enable property value notifications on your demo turbine - 11. Choose the copy icon next to the **Wind Speed** property to copy the notification topic to your clipboard. Save the notification topic to use later in this tutorial. You only need to record the notification topic from one turbine. + 11. Choose **Measurements**. @@ -83 +73 @@ In this procedure, you enable property value notifications on your demo turbine - + 12. Choose the copy icon next to the **Wind Speed** property to copy the notification topic to your clipboard. Save the notification topic to use later in this tutorial. You only need to record the notification topic from one turbine. @@ -94 +84 @@ The notification topic should look like the following example. -In this procedure, you create a rule in AWS IoT Core that parses the property value notification messages and inserts data into an Amazon DynamoDB table. AWS IoT Core rules parse MQTT messages and perform actions based on the contents and topic of each message. Then, you create a rule with a DynamoDB action to insert data to a DynamoDB table that you create as part of this tutorial. +In this step, create a rule in AWS IoT Core that parses the property value notification messages and inserts data into an Amazon DynamoDB table. AWS IoT Core rules parse MQTT messages and perform actions based on the contents and topic of each message. Then, you create a rule with a DynamoDB action to insert data to a DynamoDB table that you create as part of this tutorial. @@ -98,5 +88 @@ In this procedure, you create a rule in AWS IoT Core that parses the property va - 1. Navigate to the [AWS IoT console](https://console.aws.amazon.com/iot/). If a **Get started** button appears, choose it. - - 2. In the left navigation pane, choose **Act** and then choose **Rules**. - - + 1. Navigate to the [AWS IoT console](https://console.aws.amazon.com/iot/). @@ -104 +90 @@ In this procedure, you create a rule in AWS IoT Core that parses the property va - 3. If a **You don't have any rules yet** dialog box appears, choose **Create a rule**. Otherwise, choose **Create**. + 2. In the left navigation pane, choose **Message routing** , and then choose **Rules**. @@ -106 +92 @@ In this procedure, you create a rule in AWS IoT Core that parses the property va - 4. Enter a name and description for the rule. + 3. Choose **Create rule**. @@ -108 +94 @@ In this procedure, you create a rule in AWS IoT Core that parses the property va - + 4. Under **Specify rule properties** , enter a name and description for the rule. @@ -129,5 +115 @@ Replace the asset ID (the ID after `assets/`) in the topic with a `+`. This sele - 7. Under **Set one or more actions** , choose **Add action**. - - - - 8. On the **Select an action** page, choose **Split message into multiple columns of a DynamoDB table (DynamoDBv2)**. + 7. Under **Rule actions** , navigate to **Action 1**. @@ -135 +117 @@ Replace the asset ID (the ID after `assets/`) in the topic with a `+`. This sele - + 8. On the **Select an action** page, choose **DynamoDBv2**. This splits the message into multiple columns of a DynamoDB table @@ -137 +119 @@ Replace the asset ID (the ID after `assets/`) in the topic with a `+`. This sele - 9. Choose **Configure action** at the bottom of the page. + 9. Under **Table name** , choose **Create new table**. You create an Amazon DynamoDB table to receive wind speed data from the rule action. @@ -139 +121 @@ Replace the asset ID (the ID after `assets/`) in the topic with a `+`. This sele - 10. On the **Configure action** page, choose **Create a new resource**. + 10. Under **Table name** in the [DynamoDB console](https://console.aws.amazon.com/dynamodb/) enter a name for your table. @@ -141 +123 @@ Replace the asset ID (the ID after `assets/`) in the topic with a `+`. This sele -The DynamoDB console opens in a new tab. Keep the rule action tab open while you complete the following procedures. + 11. For **Partition key** , do the following: @@ -142,0 +125 @@ The DynamoDB console opens in a new tab. Keep the rule action tab open while you + 1. Enter `timestamp` as the partition key. @@ -143,0 +127 @@ The DynamoDB console opens in a new tab. Keep the rule action tab open while you + 2. Choose the **Number** type. @@ -144,0 +129 @@ The DynamoDB console opens in a new tab. Keep the rule action tab open while you + 3. Select the **Add sort key** check box. @@ -146,9 +131 @@ The DynamoDB console opens in a new tab. Keep the rule action tab open while you -## Step 3: Create a DynamoDB table - -In this procedure, you create an Amazon DynamoDB table to receive wind speed data from the rule action. - -###### To create a DynamoDB table - - 1. In the DynamoDB console dashboard, choose **Create table**. - - 2. Enter a name for your table. + 4. Enter `asset` as the sort key, and leave the default sort key type of **String**. @@ -156 +133 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat - + 12. Choose **Create table**. @@ -158 +135 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat - 3. For **Primary key** , do the following: + 13. Return to the tab with the **Configure action** page. @@ -160 +137 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat - 1. Enter `timestamp` as the partition key. + 14. On the **Attach rule action** page, refresh the **Table name** list, and choose your new DynamoDB table you created in the previous step. @@ -162 +138,0 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat - 2. Choose the **Number** type. @@ -164 +139,0 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat - 3. Select the **Add sort key** check box. @@ -166 +140,0 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat - 4. Enter `asset` as the sort key, and leave the default sort key type of **String**. @@ -168 +142 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat - 4. Choose **Create**. +## Step 3: Configure the DynamoDB rule action @@ -170 +144 @@ In this procedure, you create an Amazon DynamoDB table to receive wind speed dat -When the **Table is being created** notice disappears, your table is ready. +In this step, configure the Amazon DynamoDB rule action to insert data from property value updates to your new DynamoDB table. @@ -172 +146 @@ When the **Table is being created** notice disappears, your table is ready. - 5. Return to the tab with the **Configure action** page. Keep the DynamoDB tab open while you complete the following procedures. +###### To configure the DynamoDB rule action @@ -173,0 +148 @@ When the **Table is being created** notice disappears, your table is ready. + 1. Choose **Create role** to create an IAM role that grants AWS IoT Core access to perform the rule action. @@ -174,0 +150 @@ When the **Table is being created** notice disappears, your table is ready. + 2. Enter a role name, for example, `WindSpeedDataRole`. Choose **Create role**. @@ -175,0 +152 @@ When the **Table is being created** notice disappears, your table is ready. + 3. Choose **Next**. @@ -177 +154 @@ When the **Table is being created** notice disappears, your table is ready. -## Step 4: Configure the DynamoDB rule action + 4. Choose **Create** at the bottom of the page to finish creating the rule. @@ -179 +156 @@ When the **Table is being created** notice disappears, your table is ready. -In this procedure, you configure the Amazon DynamoDB rule action to insert data from property value updates to your new DynamoDB table. +Your demo asset data should start appearing in your DynamoDB table. @@ -181 +157,0 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data -###### To configure the DynamoDB rule action @@ -183 +158,0 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data - 1. On the **Configure action** page, refresh the **Table name** list, and choose your new DynamoDB table. @@ -185 +159,0 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data - @@ -187 +161 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data - 2. Choose **Create role** to create an IAM role that grants AWS IoT Core access to perform the rule action. +## Step 4: Explore data in DynamoDB @@ -189 +163 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data - 3. Enter a role name and choose **Create role**. +In this step, explore the demo assets' wind speed data in your new Amazon DynamoDB table. @@ -191 +165 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data - +###### To explore asset data in DynamoDB @@ -193 +167 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data - 4. Choose **Add action**. + 1. Return to the tab with the DynamoDB table open. @@ -195 +169 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data - 5. Choose **Create rule** at the bottom of the page to finish creating the rule. + 2. In the table you created earlier, choose the **Explore table items** tab to view the data in the table. Refresh the page if you don't see rows in the table. If rows don't appear after a few minutes, see [Troubleshoot a rule (DynamoDB)](./troubleshoot-rule.html#dynamodb-tutorial-troubleshoot-rule). @@ -197 +171 @@ In this procedure, you configure the Amazon DynamoDB rule action to insert data -Your demo asset data should start appearing in your DynamoDB table. + 3. In a row in the table, choose the edit icon to expand the data. @@ -198,0 +173 @@ Your demo asset data should start appearing in your DynamoDB table. + 4. Choose the arrow next to the **windspeed** structure to expand the list of wind speed data points. Each list reflects a batch of wind speed data points sent to AWS IoT SiteWise by the wind farm demo. You might want a different data format if you set up a rule action for your own use. For more information, see [Query asset property notifications in AWS IoT SiteWise](./query-notification-messages.html). @@ -202 +176,0 @@ Your demo asset data should start appearing in your DynamoDB table. -## Step 5: Explore data in DynamoDB @@ -204 +178 @@ Your demo asset data should start appearing in your DynamoDB table. -In this procedure, you explore the demo assets' wind speed data in your new Amazon DynamoDB table. +Now that you have completed the tutorial, disable or delete the rule and delete your DynamoDB table to avoid incurring additional charges. To clean up your resources, see Step 5: Clean up resources after the tutorial. @@ -206 +180 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz -###### To explore asset data in DynamoDB +## Step 5: Clean up resources after the tutorial @@ -208 +182 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz - 1. Return to the tab with the DynamoDB table open. +After you complete the tutorial, clean up your resources to avoid incurring additional charges. Your demo wind farm assets are deleted at the end of the duration that you chose when you created the demo. You can also delete the demo manually. @@ -210 +184 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz - 2. In the table you created earlier, choose the **Items** tab to view the data in the table. Refresh the page if you don't see rows in the table. If rows don't appear after a few minutes, see [Troubleshoot a rule (DynamoDB)](./troubleshoot-rule.html#dynamodb-tutorial-troubleshoot-rule). +The AWS IoT SiteWise demo deletes itself after a week, or the number of days you chose if you created the demo stack from the AWS CloudFormation console. You can delete the demo before if you are done using the demo resources. You can also delete the demo if the demo fails to create. Use the following steps to delete the demo manually. @@ -212 +186 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz - +**(optional) To delete the AWS IoT SiteWise demo** @@ -214 +188 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz - 3. In a row in the table, choose the edit icon to expand the data. + 1. Navigate to the [AWS CloudFormation console](https://console.aws.amazon.com/cloudformation). @@ -216 +190 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz - + 2. Choose **IoTSiteWiseDemoAssets** from the list of Stacks. @@ -218 +192 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz - 4. Choose the arrow next to the **windspeed** structure to expand the list of wind speed data points. Each list reflects a batch of wind speed data points sent to AWS IoT SiteWise by the wind farm demo. You might want a different data format if you set up a rule action for your own use. For more information, see [Query asset property notifications in AWS IoT SiteWise](./query-notification-messages.html). + 3. Choose **Delete**. @@ -220 +194 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz - +When you delete the stack, all of the resources created for the demo are deleted. @@ -221,0 +196 @@ In this procedure, you explore the demo assets' wind speed data in your new Amaz + 4. In the confirmation dialog, choose **Delete stack**.