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	Requires input	Choose up to three Availability Zones to use for the VPC subnets.
Number of Availability Zones (NumberOfAZs)	New VPC	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	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 Existing VPC	Requires input	Existing key pair to connect to virtual machine (VM) instances.
Instance AMI id	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	Existing VPC	Blank string	AMI ID to be used for the creation of the GPU enabled EC2 instance.
IAM Role ARN	Existing VPC	Blank string	ARN of a pre-deployed IAM Role with sufficient permissions for the deployment.
IAM Role name	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 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 not exposed as a parameter Existing VPC	true	Enable the cluster backup.
Load Balancer (UseLevel7LoadBalancer)	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 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 Existing VPC	eg. 22.10.0	UiPath® version to install
Installer download URL	Existing VPC	false	Choose to add a GPU-enabled VM to the deployment.
Extra configuration keys	Existing VPC	Blank string	Extra configuration keys to add to the cluster configuration.
Disable presigned URL	New VPC Existing VPC	false	Choose true to enable or disable objectstore access via pre-signed URLs.

Table 5. Automation Suite service configuration

Parameter label (name)	Template	Default value	Description
Services Install flags (multiple)	Existing VPC	true	Choose if the specific service is installed in the cluster.

Table 6: Automation Suite external registry configuration

Figure 1.

Parameter label	Template	Default value	Description
ExternalRegistryFQDN	New VPC Existing VPC	Blank string	External registry Fully Qualified Domain Name
ExternalRegistryUsername	New VPC Existing VPC	Blank string	External registry username.
ExternalRegistryPassword	New VPC Existing VPC	Blank string	External registry password.

Table 7. AI Center with external Orchestrator

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 string Orchestrator certificate Example: UExBQ0VIT0xERVI=
Base64 encoded Identity certificate	New VPC Existing VPC	Blank string	Base64 encoded string Identity certificate Example: UExBQ0VIT0xERVI=

Table 8. DNS or SSL configuration

Parameter label (name)	Templates	Default value	Description
Cluster FQDN (UiPathFQDN)	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 Route 53 hosted zone (HostedZoneID)	New VPC Existing VPC	Blank string	ID of Route 53 hosted zone or leave blank. For details, see Valid domain name. If you deploy to AWS GovCloud, you must associate the Route53 resource for your custom domain with the existing VPC.
ARN of the ACM hosted certificate to use	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	Existing VPC	false	Choose if you want to use an internal load balancer.

Table 9. RDS configuration

Parameter label (name)	Template	Default value	Description
Engine of SQL Server deployed on RDS	Existing VPC	sqlserver-se	Choose the RDS Microsoft SQL engine.
Version of SQL Server deployed on RDS	Existing VPC	15.00	Choose the RDS Microsoft SQL version.
KMS Key Id used to encrypt RDS storage	Existing VPC	Blank string	KMS Key ID to use for the encryption of the RDS storage.