Automation Suite
2022.4
false
Automation Suite Installation Guide
Last updated Jul 12, 2024

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

(AvailabilityZones)
  • New VPC
  • New VPC, in-depth configurable

Requires input

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

Number of Availability Zones

(NumberOfAZs)
  • New VPC
  • New VPC, in-depth configurable

2

Choose the number of Availability Zones to use in the VPC. This must match the number of AZs selected in the Availability Zones parameter.

Deploy Bastion host

  • New VPC, in-depth configurable
  • 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 Subnets IDs

  • Existing VPC

Blank string

List of public subnet IDs to deploy the internet-facing Load Balancer and the Bastion host.

Private Subnets IDs

  • Existing VPC

Requires Input

List of private subnet IDs.

Table 3. Automation Suite Instance Configuration

Parameter label (name)

Template

Default value

Description

Instance key pair

(KeyPairName)
  • New VPC
  • New VPC, in-depth configurable
  • Existing VPC

Requires input

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

Instance AMI id

  • New VPC, in-depth configurable
  • Existing VPC

Blank string

AMI ID to be used for the creation of the EC2 instances of the cluster.

When 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, in-depth configurable
  • Existing VPC

Blank string

AMI ID to be used for the creation of the GPU enabled EC2 instance.

IAM Role ARN

  • New VPC, in-depth configurable
  • Existing VPC

Blank string

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

IAM Role name

  • New VPC, in-depth configurable
  • Existing VPC

Blank string

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

Table 4. Automation Suite Deployment Configuration

Parameter label (name)

Template

Default value

Description

Specify Deployment Type

(MultiNode)
  • New VPC
  • New VPC, in-depth configurable
  • Existing VPC

SingleNode

Install Automation Suite in single-node evaluation mode or multi-node HA-ready production mode.

Enable cluster backup

  • New VPC – backup is enabled by default but no exposed as a parameter
  • New VPC, in-depth configurable
  • Existing VPC

true

Enable the cluster backup.

Load Balancer (UseLevel7LoadBalancer)
  • New VPC
  • New VPC, in-depth configurable
  • 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 need to manually configure the TLS certificates post deployment.

Perform Installation

  • Existing VPC

true

Perform the Automation Suite installation.

Automation Suite Version

(UiPathVersion)
  • New VPC
  • New VPC, in-depth configurable
  • Existing VPC
eg. 21.10.0

UiPath version to install

Automation Suite Product Selection

(ServiceProfile)
  • New VPC

Default Platform

Choose Default platform to install Orchestrator, Action Center, Test Manager, Insights, Automation Hub, Automation Ops.

Choose Entire platform to additionally install Apps, AI Center, Task Mining, Document Understanding.

Installer download URL

  • New VPC, in-depth configurable
  • Existing VPC

false

Choose to add a GPU-enabled VM to the deployment.

Extra configuration keys

  • New VPC, in-depth configurable
  • Existing VPC

Blank string

Extra configuration keys to add to the cluster configuration.

Table 5. Automation Suite Services

Parameter label (name)

Template

Default value

Description

Services Install flags

(multiple)

  • New VPC, in-depth configurable
  • Existing VPC

true

Choose if the specific service is installed in the cluster.

Table 6. DNS or SSL Configuration

Parameter label (name)

Templates

Default value

Description

Cluster FQDN

(UiPathFQDN)
  • New VPC
  • New VPC, in-depth configurable
  • 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 Route 53 hosted zone

(HostedZoneID)
  • New VPC
  • New VPC, in-depth configurable
  • Existing VPC

Requires input

ID of Route 53 hosted zone.

ARN of the ACM hosted certificate to use

  • New VPC, in-depth configurable
  • Existing VPC

Blank string

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

Use Internal Load Balancer

  • New VPC, in-depth configurable
  • Existing VPC

false

Choose if you want to use an internal load balancer.

Table 7. RDS Configuration

Parameter label (name)

Template

Default value

Description

Engine of SQL Server deployed on RDS

  • New VPC, in-depth configurable
  • Existing VPC

sqlserver-se

Choose the RDS Microsoft SQL engine.

Version of SQL Server deployed on RDS

  • New VPC, in-depth configurable
  • Existing VPC

15.00

Choose the RDS Microsoft SQL version.

KMS Key Id used to encrypt RDS storage

  • New VPC, in-depth configurable
  • Existing VPC

Blank string

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

Table 8. Partner Solution S3 bucket configuration

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

  • Existing VPC

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

You must not change the value.

Template-hosting S3 Region

  • New VPC

  • 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-2024 UiPath. All rights reserved.