Identity-based policy examples for AWS IoT RoboRunner - AWS IoT RoboRunner

Identity-based policy examples for AWS IoT RoboRunner

By default, IAM users and roles don't have permission to create or modify AWS IoT RoboRunner resources. They also can't perform tasks using the AWS Management Console, AWS CLI, or AWS API. An IAM administrator must create IAM policies that grant users and roles permission to perform actions on the resources that they need. The administrator must then attach those policies to the IAM users or groups that require those permissions.

To learn how to create an IAM identity-based policy using these example JSON policy documents, see Creating IAM policies in the IAM User Guide.

Policy best practices

Identity-based policies are very powerful. They determine whether someone can create, access, or delete AWS IoT RoboRunner resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations:

  • Get started using AWS managed policies – To start using AWS IoT RoboRunner quickly, use AWS managed policies to give your employees the permissions they need. These policies are already available in your account and are maintained and updated by AWS. For more information, see Get started using permissions with AWS managed policies in the IAM User Guide.

  • Grant least privilege – When you create custom policies, grant only the permissions required to perform a task. Start with a minimum set of permissions and grant additional permissions as necessary. Doing so is more secure than starting with permissions that are too lenient and then trying to tighten them later. For more information, see Grant least privilege in the IAM User Guide.

  • Enable MFA for sensitive operations – For extra security, require IAM users to use multi-factor authentication (MFA) to access sensitive resources or API operations. For more information, see Using multi-factor authentication (MFA) in AWS in the IAM User Guide.

  • Use policy conditions for extra security – To the extent that it's practical, define the conditions under which your identity-based policies allow access to a resource. For example, you can write conditions to specify a range of allowable IP addresses that a request must come from. You can also write conditions to allow requests only within a specified date or time range, or to require the use of SSL or MFA. For more information, see IAM JSON policy elements: Condition in the IAM User Guide.

Using the AWS IoT RoboRunner console

To access the AWS IoT RoboRunner console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS IoT RoboRunner resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (IAM users or roles) with that policy.

You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that you're trying to perform.

To ensure that users and roles can still use the AWS IoT RoboRunner console, also attach the AWS IoT RoboRunner AWSIotRoboRunnerFullAccess or AWSIotRoboRunnerReadOnly AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide.

Allow users to view their own permissions

This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] }

IT persona

In this example, you want to create an IT persona that can manage resources for their assigned sites. With this policy, the IT persona can manage workers and worker fleets for their assigned site.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "AllowManageSite", "Effect": "Allow", "Action": [ "iotroborunner:GetSite", "iotroborunner:CreateWorkerFleet", "iotroborunner:GetWorkerFleet", "iotroborunner:UpdateWorkerFleet", "iotroborunner:DeleteWorkerFleet", "iotroborunner:ListWorkerFleets", "iotroborunner:CreateWorker", "iotroborunner:GetWorker", "iotroborunner:UpdateWorker", "iotroborunner:DeleteWorker", "iotroborunner:ListWorkers", ], "Resource": [ "arn:aws:iotroborunner:<region>:<account>:site/<siteId>", "arn:aws:iotroborunner:<region>:<account>:site/<siteId>/*" ] } ] }

Operations manager

In this example, you want to create an operations manager who debugs operational issues on premise. The operations manager has permission to manage resources within their designated sites. They are also allowed to void tasks by updating the task to a terminal state within the task management system so the task won't be picked up by the task manager.

{ "Version":"2012-10-17", "Statement":[ { "Sid":"AllowManageSite", "Effect":"Allow", "Action":[ "iotroborunner:GetSite", "iotroborunner:CreateWorkerFleet", "iotroborunner:GetWorkerFleet", "iotroborunner:UpdateWorkerFleet", "iotroborunner:DeleteWorkerFleet", "iotroborunner:ListWorkerFleets", "iotroborunner:CreateWorker", "iotroborunner:GetWorker", "iotroborunner:UpdateWorker", "iotroborunner:DeleteWorker", "iotroborunner:ListWorkers" ], "Resource":[ "arn:aws:iotroborunner:<region>:<account>:site/<siteId>", "arn:aws:iotroborunner:<region>:<account>:site/<siteId>/*" ] }, { "Sid":"AllowDebugging", "Effect":"Allow", "Action":[ "iotroborunner:GetDestination", "iotroborunner:ListDestinations", "iotroborunner:GetDestinationRelationship", "iotroborunner:ListDestinationRelationships", "iotroborunner:GetTask", "iotroborunner:CreateTaskDependency", "iotroborunner:UpdateTask", "iotroborunner:ListTasks", "iotroborunner:GetActivity", "iotroborunner:UpdateActivity", "iotroborunner:ListActivities", "iotroborunner:CreateActionTemplate", "iotroborunner:GetActionTemplate", "iotroborunner:ListActionTemplates", "iotroborunner:CreateAction", "iotroborunner:GetAction", "iotroborunner:ListActions", "iotroborunner:UpdateActionState" ], "Resource":"arn:aws:iotroborunner:<region>:<account>:*" } ] }

Task manager

In this example, you want to create a policy so that a task manager can access resources within your account to sync AWS IoT RoboRunner workers with the worker status reported by the fleet management service. The policy also allows performing task management, planning, allocation and dispatching.

Remove the AllowTaskManagement policy statement if the task manager is only reporting worker statuses to AWS IoT RoboRunner.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "AllowReadSite", "Effect": "Allow", "Action": [ "iotroborunner:GetSite", "iotroborunner:GetWorkerFleet", "iotroborunner:ListWorkerFleets", "iotroborunner:GetWorker", "iotroborunner:ListWorkers" ], "Resource": [ "arn:aws:iotroborunner:<region>:<account>:site/<siteId>", "arn:aws:iotroborunner:<region>:<account>:site/<siteId>/*" ] }, { "Sid": "AllowUpdateWorker", "Effect": "Allow", "Action": [ "iotroborunner:UpdateWorker" ], "Resource": [ "arn:aws:iotroborunner:<region>:<account>:site/<siteId>", "arn:aws:iotroborunner:<region>:<account>:site/<siteId>/*" ] }, { "Sid": "AllowTaskManagement", "Effect": "Allow", "Action": [ "iotroborunner:GetDestination", "iotroborunner:ListDestinations", "iotroborunner:GetDestinationRelationship", "iotroborunner:ListDestinationRelationships", "iotroborunner:GetTask", "iotroborunner:CreateTask", "iotroborunner:CreateTaskDependency", "iotroborunner:UpdateTask", "iotroborunner:ListTasks", "iotroborunner:GetActivity", "iotroborunner:CreateActivity", "iotroborunner:CreateActivityDependency", "iotroborunner:UpdateActivity", "iotroborunner:ListActivities", "iotroborunner:CreateActionTemplate", "iotroborunner:GetActionTemplate", "iotroborunner:ListActionTemplates", "iotroborunner:CreateAction", "iotroborunner:GetAction", "iotroborunner:ListActions", "iotroborunner:UpdateActionState" ], "Resource":"arn:aws:iotroborunner:<region>:<account>:*" } ] }

Resource visualization

In this example, you want to create a policy that allows a user to use an application to visualize resources within your account. The application needs to assume the user's IAM role that contains the policy to perform the visualization

{ "Version":"2012-10-17", "Statement":[ { "Sid":"AllowReadSite", "Effect":"Allow", "Action":[ "iotroborunner:GetSite", "iotroborunner:GetWorkerFleet", "iotroborunner:ListWorkerFleets", "iotroborunner:GetWorker", "iotroborunner:ListWorkers" ], "Resource":[ "arn:aws:iotroborunner:<region>:<account>:site/<siteId>", "arn:aws:iotroborunner:<region>:<account>:site/<siteId>/*" ] }, { "Sid":"AllowRead", "Effect":"Allow", "Action":[ "iotroborunner:GetDestination", "iotroborunner:ListDestinations", "iotroborunner:GetDestinationRelationship", "iotroborunner:ListDestinationRelationships", "iotroborunner:GetTask", "iotroborunner:ListTasks", "iotroborunner:GetActivity", "iotroborunner:ListActivities", "iotroborunner:ListActionTemplates", "iotroborunner:GetAction", "iotroborunner:ListActions" ], "Resource":"arn:aws:iotroborunner:<region>:<account>:*" } ] }