Prerequisites for running the Amazon IoT Greengrass qualification suite

1. Create an Amazon Web Services account. If you already have an Amazon Web Services account, skip to step 2.

2. Configure permissions for IDT.

1. Open the Amazon home page, and choose Create an Amazon Account.

   Note

   If you've signed in to Amazon recently, you might see Sign In to the Console instead.

2. Follow the online instructions. Part of the sign-up procedure includes registering a credit card, receiving a text message or phone call, and entering a PIN.

   For more information, see How do I create and activate a new Amazon Web Services account?

To configure permissions for IDT (console)

Follow these steps to use the console to configure permissions for IDT for Amazon IoT Greengrass.

1. Sign in to the IAM console.

2. Create a customer managed policy that grants permissions to create roles with specific permissions.

   1. In the navigation pane, choose Policies, and then choose Create policy.

   2. On the JSON tab, replace the placeholder content with the following policy.

      {
          "Version": "2012-10-17",
          "Statement": [
              {
                  "Sid": "ManageRolePoliciesForIDTGreengrass",
                  "Effect": "Allow",
                  "Action": [
                      "iam:DetachRolePolicy",
                      "iam:AttachRolePolicy"
                  ],
                  "Resource": [
                      "arn:aws-cn:iam::*:role/idt-*",
                      "arn:aws-cn:iam::*:role/GreengrassServiceRole"
                  ],
                  "Condition": {
                      "ArnEquals": {
                          "iam:PolicyARN": [
                              "arn:aws-cn:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy",
                              "arn:aws-cn:iam::aws:policy/service-role/GreengrassOTAUpdateArtifactAccess",
                              "arn:aws-cn:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"
                          ]
                      }
                  }
              },
              {
                  "Sid": "ManageRolesForIDTGreengrass",
                  "Effect": "Allow",
                  "Action": [
                      "iam:CreateRole",
                      "iam:DeleteRole",
                      "iam:PassRole",
                      "iam:GetRole"
                  ],
                  "Resource": [
                      "arn:aws-cn:iam::*:role/idt-*",
                      "arn:aws-cn:iam::*:role/GreengrassServiceRole"
                  ]
              }
          ]
      }

      Important

      The following policy grants permission to create and manage roles required by IDT for Amazon IoT Greengrass. This includes permissions to attach the following Amazon managed policies:

      • AWSGreengrassResourceAccessRolePolicy

      • GreengrassOTAUpdateArtifactAccess

      • AWSLambdaBasicExecutionRole

   3. Choose Next: Tags.

   4. Choose Next: Review.

   5. For Name, enter IDTGreengrassIAMPermissions. Under Summary, review the permissions granted by your policy.

   6. Choose Create policy.

3. Create an IAM user and attach the permissions required by IDT for Amazon IoT Greengrass.

   1. Create an IAM user. Follow steps 1 through 5 in Creating IAM users (console) in the IAM User Guide.

   2. Attach the permissions to your IAM user:

      1. On the Set permissions page, choose Attach existing policies directly.

      2. Search for the IDTGreengrassIAMPermissions policy that you created in the previous step. Select the check box.

      3. Search for the AWSIoTDeviceTesterForGreengrassFullAccess policy. Select the check box.

         Note

         The AWSIoTDeviceTesterForGreengrassFullAccess is an Amazon managed policy that defines the permissions IDT requires to create and access Amazon resources used for testing. For more information, see Amazon managed policy for Amazon IoT Device Tester.

   3. Choose Next: Tags.

   4. Choose Next: Review to view a summary of your choices.

   5. Choose Create user.

   6. To view the user's access keys (access key IDs and secret access keys), choose Show next to the password and access key. To save the access keys, choose Download.csv and save the file to a secure location. You use this information later to configure your Amazon credentials file.

4. Next step: Configure your physical device.

To configure permissions for IDT (Amazon CLI)

Follow these steps to use the Amazon CLI to configure permissions for IDT for Amazon IoT Greengrass. If you already configured permissions in the console, skip to Configure your device to run IDT tests or Optional: Configuring your Docker container for IDT for Amazon IoT Greengrass.

1. On your computer, install and configure the Amazon CLI if it's not already installed. Follow the steps in Installing the Amazon CLI in the Amazon Command Line Interface User Guide.

   Note

   The Amazon CLI is an open source tool that you can use to interact with Amazon services from your command-line shell.

2. Create a customer managed policy that grants permissions to manage IDT and Amazon IoT Greengrass roles.

   Linux, macOS, or Unix

   aws iam create-policy --policy-name IDTGreengrassIAMPermissions --policy-document '{
       "Version": "2012-10-17",
       "Statement": [
           {
               "Sid": "ManageRolePoliciesForIDTGreengrass",
               "Effect": "Allow",
               "Action": [
                   "iam:DetachRolePolicy",
                   "iam:AttachRolePolicy"
               ],
               "Resource": [
                   "arn:aws-cn:iam::*:role/idt-*",
                   "arn:aws-cn:iam::*:role/GreengrassServiceRole"
               ],
               "Condition": {
                   "ArnEquals": {
                       "iam:PolicyARN": [
                           "arn:aws-cn:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy",
                           "arn:aws-cn:iam::aws:policy/service-role/GreengrassOTAUpdateArtifactAccess",
                           "arn:aws-cn:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"
                       ]
                   }
               }
           },
           {
               "Sid": "ManageRolesForIDTGreengrass",
               "Effect": "Allow",
               "Action": [
                   "iam:CreateRole",
                   "iam:DeleteRole",
                   "iam:PassRole",
                   "iam:GetRole"
               ],
               "Resource": [
                   "arn:aws-cn:iam::*:role/idt-*",
                   "arn:aws-cn:iam::*:role/GreengrassServiceRole"
               ]
           }
       ]
   }'

   Windows command prompt

   aws iam create-policy --policy-name IDTGreengrassIAMPermissions --policy-document '{\"Version\": \"2012-10-17\", \"Statement\": [{\"Sid\": \"ManageRolePoliciesForIDTGreengrass\",\"Effect\": \"Allow\",\"Action\": [\"iam:DetachRolePolicy\", \"iam:AttachRolePolicy\"], \"Resource\": [\"arn:aws-cn:iam::*:role/idt-*\",\"arn:aws-cn:iam::*:role/GreengrassServiceRole\"],\"Condition\": {\"ArnEquals\": {\"iam:PolicyARN\": [\"arn:aws-cn:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy\",\"arn:aws-cn:iam::aws:policy/service-role/GreengrassOTAUpdateArtifactAccess\",\"arn:aws-cn:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole\"]}}},{\"Sid\": \"ManageRolesForIDTGreengrass\",\"Effect\": \"Allow\",\"Action\": [\"iam:CreateRole\",\"iam:DeleteRole\", \"iam:PassRole\", \"iam:GetRole\"],\"Resource\": [\"arn:aws-cn:iam::*:role/idt-*\",\"arn:aws-cn:iam::*:role/GreengrassServiceRole\"]}]}'

   Note

   This step includes a Windows command prompt example because it uses a different JSON syntax than Linux, macOS, or Unix terminal commands.

3. Create an IAM user and attach the permissions required by IDT for Amazon IoT Greengrass.

   1. Create an IAM user. In this example setup, the user is named IDTGreengrassUser.

      aws iam create-user --user-name IDTGreengrassUser

   2. Attach the IDTGreengrassIAMPermissions policy you created in step 2 to your IAM user. Replace <account-id> in the command with the ID of your Amazon Web Services account.

      aws iam attach-user-policy --user-name IDTGreengrassUser --policy-arn arn:aws-cn:iam::<account-id>:policy/IDTGreengrassIAMPermissions

   3. Attach the AWSIoTDeviceTesterForGreengrassFullAccess policy to your IAM user.

      aws iam attach-user-policy --user-name IDTGreengrassUser --policy-arn arn:aws-cn:iam::aws:policy/AWSIoTDeviceTesterForGreengrassFullAccess

      Note

      The AWSIoTDeviceTesterForGreengrassFullAccess is an Amazon managed policy that defines the permissions IDT requires to create and access Amazon resources used for testing. For more information, see Amazon managed policy for Amazon IoT Device Tester.

4. Create a secret access key for the user.

   aws iam create-access-key --user-name IDTGreengrassUser

   Store the output in a secure location. You use this information later to configure your Amazon credentials file.

5. Next step: Configure your physical device.