UiPath Robot on the AWS Cloud

Quick Start Reference Deployment

QS

March 2021
Adrian Tudoran, Razvan-Valetin Grigoras, and Binoy Das, UiPath
Shivansh Singh and Tony Bulding, AWS Quick Start team

Visit our GitHub repository for source files and to post feedback, report bugs, or submit feature ideas for this Quick Start.

This Quick Start was created by UiPath in collaboration with Amazon Web Services (AWS). Quick Starts are automated reference deployments that use AWS CloudFormation templates to deploy key technologies on AWS, following AWS best practices.

Overview

This Quick Start reference deployment guide provides step-by-step instructions for deploying UiPath Robot on AWS. This Quick Start deploys UiPath Robot, the agent that runs processes designed in UiPath Studio. UiPath software robots must be connected to UiPath Orchestrator in order to execute processes, or they have to be licensed locally. The type of robot you have at your disposal is determined by its license, while the robot service is determined by the deployment. For more information, see About Licensing.

This Quick Start deploys UiPath Robot. UiPath software robots can be deployed, secured, and managed at scale using UiPath Orchestrator, the centralized robot management tool from UiPath. A Quick Start reference deployment for UiPath Orchestrator on the AWS Cloud is also available.
Amazon may share user-deployment information with the AWS Partner that collaborated with AWS on the Quick Start.

UiPath Robot on AWS

UiPath Robot is the agent that runs processes designed in UiPath Studio. A UiPath Robot is split into several components, each being dedicated to a particular automation task. This design allows you to run, identify, and track the work of each component. With UIPath Robots, you can capture data from user interfaces, manipulate applications, and communicate with other systems to perform repetitive business processes. Depending on its license, a UiPath software robot can be attended or unattended. For more information, see Introduction in the UiPath Robot Guide.

AWS costs

You are responsible for the cost of the AWS services and any third-party licenses used while running this Quick Start. There is no additional cost for using the Quick Start.

The AWS CloudFormation templates for Quick Starts include configuration parameters that you can customize. Some of the settings, such as the instance type, affect the cost of deployment. For cost estimates, see the pricing pages for each AWS service you use. Prices are subject to change.

After you deploy the Quick Start, create AWS Cost and Usage Reports to deliver billing metrics to an Amazon Simple Storage Service (Amazon S3) bucket in your account. These reports provide cost estimates based on usage throughout each month and aggregate the data at the end of the month. For more information, see What are AWS Cost and Usage Reports?

Software licenses

This Quick Start only installs UiPath Robot. It does not require a UiPath Orchestrator instance. If you decide to connect it to UiPath Orchestrator, you must configure UiPath Robot manually. This deployment supports UiPath Orchestrator version 20.4.x and later.

The Quick Start uses only AWS-provided Microsoft Windows images and does not require a subscription to the Amazon Machine Image (AMI).

Architecture

Deploying this Quick Start for a new virtual private cloud (VPC) with default parameters builds the following UiPath Robot environment in the AWS Cloud.

Architecture
Figure 1. Quick Start architecture for UiPath Robot on AWS

As shown in Figure 1, the Quick Start sets up the following:

  • A highly available architecture that spans two or more Availability Zones.

  • A VPC configured with public and private subnets, according to AWS best practices, to provide you with your own virtual network on AWS.*

  • In the public subnets:

    • Managed NAT gateways to allow outbound internet access for resources in the private subnets.*

    • A Windows bastion host to allow inbound Remote Desktop Protocol (RDP) access to Amazon Elastic Compute Cloud (Amazon EC2) instances in private subnets.*

    • A security group controlling inbound and outbound traffic to the bastion host instances.

  • In the private subnets:

    • Amazon EC2 instances to host UiPath Robot.

    • A security group controlling inbound and outbound traffic to the UiRobot instances.

*The template that deploys the Quick Start into an existing VPC skips the components marked by asterisks and prompts you for your existing VPC configuration.

Planning the deployment

Specialized knowledge

This deployment requires a moderate level of familiarity with AWS services. If you’re new to AWS, see Getting Started Resource Center and AWS Training and Certification. These sites provide materials for learning how to design, deploy, and operate your infrastructure and applications on the AWS Cloud.

This deployment guide requires a moderate level of familiarity with the following AWS services:

AWS account

If you don’t already have an AWS account, create one at https://aws.amazon.com by following the on-screen instructions. Part of the sign-up process involves receiving a phone call and entering a PIN using the phone keypad.

Your AWS account is automatically signed up for all AWS services. You are charged only for the services you use.

Technical requirements

Before you launch the Quick Start, review the following information and ensure that your account is properly configured. Otherwise, deployment might fail.

Resource quotas

If necessary, request service quota increases for the following resources. You might need to request increases if your existing deployment currently uses these resources and if this Quick Start deployment could result in exceeding the default quotas. The Service Quotas console displays your usage and quotas for some aspects of some services. For more information, see What is Service Quotas? and AWS service quotas.

Resource This deployment uses

VPCs

1

Subnets

Up to 9

NAT gateways

Up to 3

VPC endpoints

1

Internet gateways

1

Elastic IP addresses

Up to 3

IAM security groups

1

IAM roles

2

Bastion hosts

1

Supported Regions

Based on the availability of the Amazon EC2 AMI, the AWS CloudFormation stack can be launched in the following Regions:

  • us-east-1 (N. Virginia)

  • us-east-2 (Ohio)

  • us-west-1 (N. California)

  • us-west-2 (Oregon)

  • af-south-1 (Cape Town)

  • ap-northeast-1 (Tokyo)

  • ap-northeast-2 (Seoul)

  • ap-southeast-1 (Singapore)

  • ap-southeast-2 (Sydney)

  • ap-east-1 (Hong Kong)

  • ap-south-1 (Mumbai)

  • ap-northeast-3 (Osaka-Local)

  • ca-central-1 (Canada)

  • eu-central-1 (Frankfurt)

  • eu-west-1 (Ireland)

  • eu-west-2 (London)

  • eu-south-1 (Milan)

  • eu-west-3 (Paris)

  • eu-north-1 (Stockholm)

  • me-south-1 (Bahrain)

  • sa-east-1 (São Paulo)

For a list of supported Regions, see AWS service endpoints.

Certain Regions are available on an opt-in basis. For more information, see Managing AWS Regions.

EC2 key pairs

Make sure that at least one Amazon EC2 key pair exists in your AWS account in the Region where you plan to deploy the Quick Start. Make note of the key pair name. You need it during deployment. To create a key pair, see Amazon EC2 key pairs and Linux instances.

For testing or proof-of-concept purposes, we recommend creating a new key pair instead of using one that’s already being used by a production instance.

IAM permissions

Before launching the Quick Start, you must sign in to the AWS Management Console with IAM permissions for the resources that the templates deploy. The AdministratorAccess managed policy within IAM provides sufficient permissions, although your organization may choose to use a custom policy with more restrictions. For more information, see AWS managed policies for job functions.

Prepare your AWS account

Key pair

Make sure that at least one Amazon EC2 key pair exists in your AWS account in your Region. Note the key-pair name because you will need it during deployment. For more information, see Amazon EC2 key pairs and Linux instances.

For testing or proof-of-concept purposes, we recommend creating a new key pair instead of using one that’s already in use by a production instance. For more information, see Create a key pair, later in this guide.

Deployment options

This Quick Start provides a two deployment options:

  • Deploy UiPath Robot into a new VPC. This option option builds a new AWS environment consisting of the VPC, subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components. It then deploys UiPath Robot into this new VPC. To set up the networking and routing infrastructure, you only provide the CIDR block for the VPC that you want to create. However, you can configure instance types and software settings such as license keys, user names, and passwords, as discussed later in this guide.

  • Deploy UiPath Robot into an existing VPC. Provisions resources into your existing AWS VPC.

Deployment steps

Sign in to your AWS account

  1. Sign in to your AWS account at https://aws.amazon.com with an IAM user role that has the necessary permissions. For more information, see Create IAM user, later in this guide.

  2. Make sure that your AWS account is configured correctly, as discussed in the Technical requirements section.

Deploy the Quick Start

You are responsible for the cost of the AWS services used while running this Quick Start reference deployment. There is no additional cost for using this Quick Start. For full details, see the pricing pages for each AWS service you use. Prices are subject to change.

Each deployment takes about 25 minutes to complete.

  1. Sign in to your AWS account, and choose one of the following options to launch the AWS CloudFormation template. For help with choosing an option, see Deployment options earlier in this guide.

Deploy UiPath Robot into a new VPC on AWS

View template

Deploy UiPath Robot into an existing VPC on AWS

View template

  1. Check the AWS Region displayed in the upper-right corner of the navigation bar, and change it if necessary. This Region is where the network infrastructure for UiPath Robot is built. The template launches in the us-east-1 Region by default.

  1. On the Create stack page, keep the default setting for the template URL, and then choose Next.

  2. On the Specify stack details page, change the stack name if needed, and review the parameters for the template. Provide values for any parameters that require input. For all other parameters, review the default settings and customize them as necessary. For details on each parameter, see the Parameter reference section of this guide. When you finish reviewing and customizing the parameters, choose Next.

  3. On the Configure stack options page, you can specify tags (key-value pairs) for resources in your stack and set advanced options. When you’re finished, choose Next.

  4. On the Review page, review and confirm the template settings. Under Capabilities, select the two check boxes to acknowledge that the template creates IAM resources and might require the ability to automatically expand macros.

  5. Choose Create stack to deploy the stack.

  6. Monitor the status of the stack. When the status is CREATE_COMPLETE, the UiPath Robot deployment is ready.

  7. To view the created resources, see the values displayed in the Outputs tab for the stack.

Test the deployment

If you provided a UiPath Orchestrator URL during deployment, log in to UiPath Orchestrator. Then, verify that the UiPath Robot is present and connected to the tenant.

test1
Figure 2. Test the deployment

The deployment creates a MODERN directory called AWSDeployed, which contains UiPath Robot.

  • For an unattended UiPath software robot, the STATUS is N/A because the new local administrator account is not yet logged in. However, you can run jobs.

  • For an attended UiPath software robot, the STATUS is DISCONNECTED because the built-in administrator account is not logged in.

Access the UiPath Robot VM from the bastion host to check that it is deployed successfully. Connect to an attended UiPath software robot through the administrator account. To retrieve the password, use your private key. For an unattended robot, retrieve the user account from the Robots page in UiPath Orchestrator. The user format is domain/username or machinename/username. Use the same password you used during deployment.

test2
Figure 3. Test the deployment

Create a key pair

Amazon EC2 uses public-key cryptography to encrypt and decrypt login information. In Windows instances, the key pair obtains the administrator password from the Amazon EC2 console and then logs in using RDP. On Linux, the key pair authenticates the SSH (Secure Shell) login. For more information, see Amazon EC2 key pairs and Linux instances.

To create a key pair in your preferred Region, do the following:

  1. In your AWS Management Console, choose an AWS Region.

  2. On the Services menu, choose EC2.

  3. Under Network and Security, choose Key Pairs.

  4. Choose Create Key Pair.

  5. Enter a name and choose Create.

ds1
Figure 4. Create a key pair

Create IAM user

A user login with programmatic access to following AWS services is required to launch the Quick Start CloudFormation stack.

  • AWS CloudFormation

  • AWS IAM, Amazon EC2

  • Amazon S3

  • AWS Lambda

  • AWS Storage Gateway.

If you do already have an IAM user with full access to these services, or have administrator access, you can skip this section.
  1. If you do not already have such an IAM user, create one from AWS console. In Figure 5, a user is created with programmatic and console access.

IAM
Figure 5. Adding an IAM user
  1. To follow AWS best practices, allow access to required services. When setting permissions for the user, choose Attach existing policies directly. Then choose roles with full access for each of the services listed previously.

IAM
Figure 6. Setting permissions
As shown in Figure 6, you can filter the list using the search box.
  1. Choose Next: Tags and optionally add a Name tag to identify the user.

    IAM
    Figure 7. Adding optional tags
  1. Choose Next: Review and verify that the user is configured with full access to the services listed previously.

    IAM
    Figure 8. Reviewing user details
  1. Choose Create User.

  2. Choose Download .csv to download and store the user’s security credentials in CSV format for future reference.

IAM
Figure 9. IAM user created

Best practices for using UiPath Robot on AWS

High availability and disaster recovery

Amazon EC2 provides the ability to place instances in multiple locations composed of AWS Regions and Availability Zones. Regions are dispersed and located in separate geographic areas. Availability Zones are distinct locations within a Region isolated from failures in other Availability Zones. They provide inexpensive, low-latency network connectivity to other Availability Zones in the same Region.

To make sure that an application is closer to certain customers, or for legal or design requirements, you can launch instances in separate Regions. By launching your instances in separate Availability Zones, you can protect your applications from the failure of a single location. Microsoft Exchange provides infrastructure features that complement the high availability and disaster recovery (DR) scenarios supported in the AWS Cloud.

The Quick Start also provides the option to deploy into a minimum of two Availability Zones. This option mitigates the loss of quorum in the case of a failure of a single node. However, you can choose this option only in AWS Regions that include two or more Availability Zones. For a current list of Availability Zones, see AWS Global Infrastructure.

To customize UiPath software for your business, IT, and security requirements, consult the UiPath Documentation Portal.

Security

Security groups and firewalls

When Amazon EC2 instances are launched, they must be associated with a security group, which acts as a stateful firewall. You have complete control over the security group’s inbound and outbound network traffic. You can build granular rules that are scoped by protocol, port number, and source/destination IP address, or other security groups. By default, all outbound traffic from security group is permitted. Inbound traffic, however, must be configured to allow the appropriate traffic to reach your instances. We recommend that you tightly control inbound traffic. Doing this reduces the attack surface of your EC2 instances yet leaves the following ports open for application communication.

UiPath Robot TCP ports

security1
Figure 10. TCP ports
  • 3389 for RDP access

  • 443 for communication with UiPath Orchestrator

This Quick Start configures the following security groups:

Security group Associated with Inbound source Ports

StackName-SecurityStack-RobotSecurityGroup

Robots

0.0.0.0/0

Inbound: 443, 3389
Outbound: any ports

For more information, see Security Best Practices.

Security of the AWS infrastructure

AWS provides a set of building blocks, such as Amazon EC2 and Amazon VPC, that you can use to provision your application’s infrastructure. AWS operates under a shared security responsibility model. AWS is responsible for the security of the underlying cloud infrastructure and you are responsible for securing workloads you deploy in AWS. For more information, see Introduction to AWS Security.

Resources

FAQ

Q. I encountered a CREATE_FAILED error when I launched the Quick Start.

A. If AWS CloudFormation fails to create the stack, relaunch the template with Rollback on failure set to Disabled. This setting is under Advanced in the AWS CloudFormation console on the Configure stack options page. With this setting, the stack’s state is retained, and you can troubleshoot the issue.

When you set Rollback on failure to Disabled, you continue to incur AWS charges for this stack. Make sure that you delete stack after troubleshooting.

For more information, see Troubleshooting AWS CloudFormation.

Q. I encountered a size-limitation error when I deployed the AWS CloudFormation templates.

A. Launch the Quick Start templates from the links in this guide or from another S3 bucket. If you deploy the templates from a local copy on your computer or from a location other than an S3 bucket, you might encounter template-size limitations. For more information, see AWS CloudFormation quotas.

Parameter reference

Unless you are customizing the Quick Start templates for your own deployment projects, keep the default settings for the parameters labeled Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. Changing these parameter settings automatically updates code references to point to a new Quick Start location. For more information, see the AWS Quick Start Contributor’s Guide.

Launch into a new VPC

Table 1. Availability Zone configuration
Parameter label (name) Default value Description

Availability Zones (AvailabilityZones)

Requires input

List of Availability Zones to use for the subnets in the VPC. A maximum of three Availability Zones are used for this deployment.

Number of Availability Zones to use (NumberOfAZs)

2

Number of Availability Zones to use in the VPC. Must match the number of Availability Zones chosen in the Availability Zones parameter.

Table 2. Network configuration
Parameter label (name) Default value Description

VPC CIDR (VPCCIDR)

10.0.0.0/16

VPC CIDR block, in format x.x.0.0/16.

Public subnet 1 tag (PublicSubnetTag1)

Network=Public1

(Optional) Tag to add to public subnet 1, in format Key=Value.

Public subnet 2 tag (PublicSubnetTag2)

Network=Public2

(Optional) Tag to add to public subnet 2, in format Key=Value.

Public subnet 3 tag (PublicSubnetTag3)

Network=Public3

(Optional) Tag to add to public subnet 3, in format Key=Value.

Private subnet 1 tag (PrivateSubnetTag1)

Network=Private1

(Optional) Tag to add to private subnet 1, in format Key=Value.

Private subnet 2 tag (PrivateSubnetTag2)

Network=Private2

(Optional) Tag to add to private subnet 2, in format Key=Value.

Private subnet 3 tag (PrivateSubnetTag3)

Network=Private3

(Optional) Tag to add to private subnet 3, in format Key=Value.

Table 3. Robot VM configuration
Parameter label (name) Default value Description

Instance key pair (KeyPairName)

Requires input

Key pair used to log in to virtual machine (VM) instances.

Instance type (InstanceType)

t2.medium

EC2 instance type.

Table 4. UiPath Robot configuration
Parameter label (name) Default value Description

UiPath Robot version (RobotVersion)

21.4.3

UIPath Robot version to install.

UiPath Robot type (attended/unattended) (RobotType)

Attended

Choose the type of UiPath Robot you want to install (attended or unattended).

Administrator password (AdminPassword)

Requires input

Windows administrator password for UiPath Robot.

UiPath Orchestrator URL (OrchestratorURL)

Requires input

UiPath Orchestrator URL.

UiPath Robot tenant name (OrchestratorTenant)

default

Tenant name where the UiPath Robot is created.

UiPath Orchestrator API username (OrchestratorAPIUser)

Requires input

UiPath Orchestrator API username. This must have a role with permissions to add and create robots.

UiPath Orchestrator API password (OrchestratorAPIPassword)

Requires input

UiPath Orchestrator API password.

Table 5. Quick Start S3 bucket configuration
Parameter label (name) Default value Description

Template-hosting S3 bucket (QSS3BucketName)

aws-quickstart

Name of the S3 bucket for your copy of the Quick Start assets. Keep the default name unless you are customizing the template. Changing the name updates code references to point to a new Quick Start location. This name can include numbers, lowercase letters, uppercase letters, and hyphens, but do not start or end with a hyphen (-). See https://aws-quickstart.github.io/option1.html.

Template folder (QSS3KeyPrefix)

quickstart-uipath-robot/

S3 key prefix that is used to simulate a directory for your copy of the Quick Start assets. Keep the default prefix unless you are customizing the template. Changing this prefix updates code references to point to a new Quick Start location. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html and https://aws-quickstart.github.io/option1.html.

Launch into an existing VPC

Table 6. Network configuration
Parameter label (name) Default value Description

VPC CIDR (VPCCIDR)

10.0.0.0/16

VPC CIDR block, in format x.x.0.0/16.

VPC ID (VPCID)

Requires input

ID of the VPC where the UiPath Robot is created.

Private subnet (PrivateSubnetID)

Requires input

Private subnet with UiPath Robot.

Public subnet (PublicSubnetID)

Requires input

Public subnet with bastion host to access UiPath Robot.

Table 7. Robot VM configuration
Parameter label (name) Default value Description

Instance key pair (KeyPairName)

Requires input

Key pair used to log in to virtual machine (VM) instances.

Instance type (InstanceType)

t2.medium

EC2 instance type.

Table 8. UiPath Robot configuration
Parameter label (name) Default value Description

UiPath Robot version. (RobotVersion)

21.4.3

UIPath Robot version to install.

UiPath Robot type (attended or unattended) (RobotType)

Attended

Choose the type of UiPath Robot you want to install (attended or unattended).

Administrator password (AdminPassword)

Requires input

Windows administrator password for UiPath Robot.

URL of an existing and licensed Orchestrator (OrchestratorURL)

Requires input

UiPath Orchestrator URL.

UiPath Robot tenant name (OrchestratorTenant)

default

Tenant name where the UiPath Robot is created.

UiPath Orchestrator API username (OrchestratorAPIUser)

Requires input

UiPath Orchestrator API username. This must have a role with permissions to add and create robots.

UiPath Orchestrator API password (OrchestratorAPIPassword)

Requires input

UiPath Orchestrator API password.

Table 9. Quick Start S3 bucket configuration
Parameter label (name) Default value Description

Template-hosting S3 bucket (QSS3BucketName)

aws-quickstart

Name of the S3 bucket for your copy of the Quick Start assets. Keep the default name unless you are customizing the template. Changing the name updates code references to point to a new Quick Start location. This name can include numbers, lowercase letters, uppercase letters, and hyphens, but do not start or end with a hyphen (-). See https://aws-quickstart.github.io/option1.html.

Template folder (QSS3KeyPrefix)

quickstart-uipath-robot/

S3 key prefix that is used to simulate a directory for your copy of the Quick Start assets. Keep the default prefix unless you are customizing the template. Changing this prefix updates code references to point to a new Quick Start location. This prefix can include numbers, lowercase letters, uppercase letters, hyphens (-), and forward slashes (/). See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html and https://aws-quickstart.github.io/option1.html.

Send us feedback

To post feedback, submit feature ideas, or report bugs, use the Issues section of the GitHub repository for this Quick Start. To submit code, see the Quick Start Contributor’s Guide.

Quick Start reference deployments

GitHub repository

Visit our GitHub repository to download the templates and scripts for this Quick Start, to post your comments, and to share your customizations with others.


Notices

This document is provided for informational purposes only. It represents AWS’s current product offerings and practices as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS’s products or services, each of which is provided “as is” without warranty of any kind, whether expressed or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.

The software included with this paper is licensed under the Apache License, version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://aws.amazon.com/apache2.0/ or in the accompanying "license" file. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for specific language governing permissions and limitations.