automation-suite
2024.10
true
UiPath logo, featuring letters U and I in white

Automation Suite on Linux Installation Guide

Last updated Feb 7, 2025

AWS deployment parameters

This page documents the AWS parameters you need to configure when deploying Automation Suite to AWS.

Important:

The Template-hosting S3 Region parameter must match exactly the AWS region in which you try to deploy. If the region does not match, the deployment does not succeed.

Keep the default settings for the parameters labeled Quick Start S3 bucket name, Quick Start S3 bucket Region, and Quick Start S3 key prefix. If these input parameters are altered, the deployment does not succeed.

Table 1. Availability Zone configuration

Parameter label (name)

Template

Default value

Description

Availability Zones

  • New VPC

Requires input

Choose up to three Availability Zones to use for the VPC subnets.

Number of Availability Zones

  • New VPC
  • Existing VPC

2

Choose the number of Availability Zones to use in the VPC.

For a new VPC, this must match the number you set using the Availability Zones parameter.

For an existing VPC, you can set two or three Availability Zones.

Deploy Bastion host

  • New VPC
  • Existing VPC

true

Deploy a Bastion host inside the public subnet.

Table 2. Network configuration

Parameter label (name)

Template

Default value

Description

VPC CIDR

  • Existing VPC

10.0.0.0/16

VPC CIDR block. Example: x.y.0.0/16, x.y.z.0/24.

VPC ID

  • Existing VPC

Requires Input

ID of the existing VPC.

Public subnet IDs

  • Existing VPC

Blank string

List of public subnet IDs where the internet-facing Load Balancer and the Bastion host will be deployed.

Private subnet IDs

  • Existing VPC

Requires Input

List of private subnet IDs.

Table 3. Automation Suite node configuration

Parameter label (name)

Template

Default value

Description

Server instance type

  • New VPC
  • Existing VPC

c5.4xlarge

Choose the node type for the Server node instances.

Server instance count

  • New VPC
  • Existing VPC

3

Choose the number of nodes to deploy as Server node instances.

Agent instance type

  • New VPC
  • Existing VPC

c5.4xlarge

Choose the node type for the Agent node instances.

Agent instance count

  • New VPC
  • Existing VPC

1

Choose the number of nodes to deploy as Agent node instances.

GPU agent instance type

  • New VPC
  • Existing VPC

p3.2xlarge

Choose the node type for the GPU Agent node instance.

Task Mining agent instance type

  • New VPC
  • Existing VPC

c4.8xlarge

Choose the node type for the Task Mining Agent node instance.

AS Robots agent instance type

  • New VPC
  • Existing VPC

c5a.4xlarge

Choose the node type for the AS Robots Agent node instance.

AS Robots agent instance count

  • New VPC
  • Existing VPC

1

Choose the number of nodes to deploy as AS Robots Agent node instances.

Table 3. Automation Suite instance configuration

Parameter label (name)

Template

Default value

Description

Instance key pair

  • New VPC
  • Existing VPC

Requires input

Existing key pair to connect to virtual machine (VM) instances.

Instance AMI ID

  • New VPC
  • Existing VPC

Blank string

AMI ID to use for the creation of the EC2 instances of the cluster.

When the AMI ID is not specified, the default version deployed is RHEL 8.3 for non GPU VM and RHEL 8.2 for GPU VM.

GPU instance AMI ID

  • New VPC
  • Existing VPC

Blank string

AMI ID to use for the creation of the GPU-enabled EC2 instance.

IAM Role ARN

  • New VPC
  • Existing VPC

Blank string

ARN of a pre-deployed IAM Role with sufficient permissions for the deployment.

IAM Role name

  • New VPC
  • Existing VPC

Blank string

Name of a pre-deployed IAM Role with sufficient permissions for the deployment

Table 5. Automation Suite deployment configuration

Parameter label (name)

Template

Default value

Description

Enable cluster backup

  • New VPC
  • Existing VPC

true

Enable the cluster backup.

Use a shared bucket for external storage
  • New VPC
  • Existing VPC
falseEnable a shared bucket across products. If you choose true, Process Mining and Data Service require a dedicated bucket each.

Load Balancer

  • New VPC
  • Existing VPC

ALB

Select either an Application Load Balancer (ALB) or a Network Load Balancer (NLB). If you select a Network Load Balancer, then you must configure the TLS certificates manually post deployment.

Perform Installation

  • Existing VPC

true

Perform the Automation Suite installation.

Automation Suite Version

  • New VPC
  • Existing VPC
e.g. 23.4.0

Automation Suite version to install.

Installer download URL

  • New VPC
  • Existing VPC

false

Custom URL for installer download. Leave empty to use the UiPath version.

Add GPU-enabled VMs
  • New VPC
  • Existing VPC
falseChoose true to add a GPU-enabled VM to the deployment.

Extra configuration keys

  • New VPC
  • Existing VPC

Blank string

Extra configuration keys to add to the cluster configuration.

Validity of the self-signed certificate
  • New VPC
  • Existing VPC

1825

Validity, in days, of the self-signed certificate that the deployment uses to encrypt traffic inside the VPC.

Table 5. Automation Suite service configuration

Parameter label (name)

Template

Default value

Description

Service install flags

(multiple)

  • New VPC
  • Existing VPC

true

Choose if a specific service is installed in the cluster.

Table 6: Automation Suite external registry configuration

Figure 1.

Parameter label

Template

Default value

Description

External Registry Fully Qualified Domain Name
  • New VPC
  • Existing VPC
Blank stringExternal registry Fully Qualified Domain Name
External Registry user name
  • New VPC
  • Existing VPC
Blank stringExternal registry username.
External Registry password
  • New VPC
  • Existing VPC
Blank stringExternal registry password.

Table 8. Automation Suite external Orchestrator configuration

Parameter label (name)

Template

Default value

Description

Connect AI Center to an external Orchestrator

  • New VPC
  • Existing VPC

false

Register AI Center to an external Orchestrator.

Orchestrator URL

  • New VPC
  • Existing VPC

Blank string

URL of the external Orchestrator.

Example: https://my-orchestrator.net

Identity URL

  • New VPC
  • Existing VPC

Blank string

URL of the Identity server used.

Example: https://my-orchestrator.net/identity

Base64-encoded Orchestrator certificate

  • New VPC
  • Existing VPC

Blank string

Base64-encoded Orchestrator certificate string.

Example: UExBQ0VIT0xERVI=

Base64-encoded Identity certificate

  • New VPC
  • Existing VPC

Blank string

Base64-encoded Identity certificate string.

Example: UExBQ0VIT0xERVI=

Table 9. DNS or SSL configuration

Parameter label (name)

Templates

Default value

Description

Hosting FQDN

  • New VPC
  • Existing VPC

Requires input

Fully qualified domain name (FQDN) for Automation Suite. This must be either a subdomain or root domain of the of ID of Route 53 hosted zone parameter.

ID of Amazon Route 53-hosted zone

  • New VPC
  • Existing VPC

Blank string

Enter the ID of the Route 53-hosted zone or leave blank. For details, see Valid domain name.

If you deploy to AWS GovCloud, you must associate the Route 53 resource for your custom domain with the existing VPC.

ARN of the ACM-hosted certificate

  • New VPC
  • Existing VPC

Blank string

ARN of the certificate present in the ACM (Amazon Certificate Manager) to use with the ALB.

This parameter is mandatory if you deploy to AWS GovCloud.

Use Internal Load Balancer

  • New VPC
  • Existing VPC

false

Choose if you want to use an internal load balancer.

Table 10. Amazon RDS configuration

Parameter label (name)

Template

Default value

Description

Engine of SQL Server deployed on RDS

  • New VPC
  • Existing VPC

sqlserver-se

Choose the RDS Microsoft SQL engine.

Version of SQL Server deployed on Amazon RDS

  • New VPC
  • Existing VPC

15.00

Choose the RDS Microsoft SQL version.

AWS KMS Key Id used to encrypt Amazon RDS storage

  • New VPC
  • Existing VPC

Blank string

KMS Key ID to use for the encryption of the RDS storage.

Table 8. Quick Start S3 bucket configuration

Parameter label (name)TemplateDefault valueDescription
Template folder
  • New VPC

  • New VPC, in-depth configurable

  • Existing VPC

aws-quickstart-sf-v2022-4-5/

You must not change the value.

Template-hosting S3 Region

  • New VPC

  • New VPC, in-depth configurable

  • Existing VPC

us-east-1

Must match the region where you deploy the resources in AWS. For example, if you want to deploy in us-east-1, select us-east-1.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2025 UiPath. All rights reserved.