Skip to main content

AWS CloudFormation and ArcGIS

You can use Amazon Web Services (AWS) CloudFormation templates provided by Esri to build various ArcGIS Enterprise architectures.

In most cases, you will use a combination of CloudFormation templates to build and, subsequently, upgrade a deployment.

AWS CloudFormation

AWS CloudFormation is a service that helps define architectures on Amazon Web Services. It is an example of infrastructure as code, meaning you write code that can deploy a particular hardware infrastructure in a cloud environment. With CloudFormation, you use a JavaScript Object Notation (JSON) template to define a stack of resources that work together in a predetermined way. CloudFormation ensures that you maintain a minimum number of machines in a site, allowing for recovery when one of the machines is unavailable.

You can also use CloudFormation templates to launch and maintain a deployment rather than connecting to Amazon Elastic Compute Cloud (EC2) instances to install and configure software. Plus, CloudFormation templates enable you to set up identical architectures in different AWS accounts or regions.

Esri CloudFormation templates

Esri stores CloudFormation templates in an Amazon Simple Storage Service (S3) bucket, from which you can download them. Templates are specific to an ArcGIS release. You can also copy and modify these templates to fit your needs, or create your own templates to implement your deployment patterns.

Use the Esri CloudFormation templates to launch stacks from AWS Management Console or script stack creation.

For general information about the CloudFormation templates provided by Esri, see Esri AWS CloudFormation templates. For information about specific templates, use the links in the tables below.

Passwords used in CloudFormation templates

It's recommended that you store your passwords in AWS Secrets Manager and use the secret Amazon Resource Name (ARN) for the passwords instead of providing passwords in plain text.

When you create a secret ARN in the Secrets Manager service of AWS Management Console for a password used with Esri CloudFormation templates, you must do the following:

  • Choose Other types of secrets for secret type and use the Plaintext option.

  • Delete all default text from the input field before you type the password.

Quick links

The following sections provide descriptions and consolidated lists of links to the CloudFormation templates that Esri provides.

Templates that create required cloud infrastructure

Use the templates in the following table to create AWS resources that are required before you can deploy ArcGIS in AWS.

Templates to create infrastructure

Deployment created

Description

View template

Amazon Virtual Private Cloud (VPC) with public subnets

An Amazon Virtual Private Cloud (VPC) is a virtual network. You must have a VPC in which to create your deployments on AWS.

arcgis-vpc.template.json

VPC with a NAT Gateway and public and private subnets

An Amazon VPC is a virtual network. You must have a VPC in which to create your deployments on AWS. A VPC with a NAT gateway and private subnet provides an extra level of security.

arcgis-vpc-dmz.template.json

Classic Elastic Load Balancer

An Amazon Elastic Load Balancer (ELB) directs network traffic to Amazon Elastic Compute Cloud (EC2) instances.

This template creates an ELB with an SSL certificate configured in it. The load balancer can be internet facing, which means you can use it with public subnets, or internal, which means you can use it with private subnets.

You must create one load balancer per site or portal when you use a classic load balancer.

arcgis-classic-loadbalancer.template.json

Application load balancer

An ELB directs network traffic to EC2 instances.

This template creates an ELB with an SSL certificate configured in it. The load balancer can be internet facing, which means you can use it with public subnets, or internal, which means you can use it with private subnets.

You can use a single application load balancer for all components of an ArcGIS Enterprise deployment. If you use a load balancer with an ArcGIS Notebook Server site, it must be an application load balancer.

arcgis-application-loadbalancer.template.json

Shared file server instance

If you deploy ArcGIS Enterprise components on separate EC2 instances, you can use this template to create an EC2 instance to use for directories used by the different components in a single ArcGIS Enterprise deployment. Create the file share first, then provide the ID of the instance when you run the Portal for ArcGIS, ArcGIS Server, and ArcGIS Data Store templates.

arcgis-instance-for-file-shares.template.json

Templates for all-in-one deployments

If you deploy for testing purposes or on very large EC2 instances for a production deployment, you can use the templates that create the components for a base ArcGIS Enterprise deployment on the same EC2 instance.

Templates to create a base ArcGIS Enterprise deployment on the same instance

Deployment created

Description

View template

ArcGIS Enterprise components on a single machine

If you do not require high availability, you can use this template to deploy Portal for ArcGIS, a single-machine ArcGIS GIS Server site (hosting server), and ArcGIS Data Store (relational) on the same EC2 instance.

arcgis-enterprise-allinone.template.json

ArcGIS Enterprise components duplicated on two machines for high availability

Use this template to create two identical EC2 instances (a primary and standby instance), each containing the same ArcGIS Enterprise components—Portal for ArcGIS, an ArcGIS GIS Server site (hosting server), and ArcGIS Data Store (relational).

arcgis-enterprise-ha.template.json

Templates that create components on separate EC2 instances

Rather than deploying all ArcGIS Enterprise components on the instances, you can use the following templates in combination to build an ArcGIS Enterprise deployment with each component on separate EC2 instances. This allows a more customized deployment. For example, you can size machines differently for each component or create different numbers of machines for each component.

Note:

All ArcGIS Enterprise components that are part of the same deployment must be deployed in the same VPC. All components and resources (including the VPC) must run under the same AWS account.

The following is a summary of steps to create a base ArcGIS Enterprise deployment. Templates are listed in the order they must be used. Use one template from each step (single machine or highly available).

  1. Deploy Portal for ArcGIS on a single machine or create a highly available Portal for ArcGIS deployment.

  2. Create an ArcGIS GIS Server site using the ArcGIS Server on a single-machine template or the highly available ArcGIS Server site template.

  3. Create a relational store using the ArcGIS Data Store on a single-machine template or the primary-standby ArcGIS Data Store template.

  4. Run the CloudFormation template to federate the ArcGIS GIS Server site with ArcGIS Enterprise, and add the site created in step 2 as the hosting server.

  5. Add an object store to the ArcGIS Enterprise deployment.

To deploy additional server sites federated with the base ArcGIS Enterprise deployment, run the appropriate template listed in the following table to create each site, then run the template to federate each one with ArcGIS Enterprise.

Templates to deploy ArcGIS Enterprise components on separate instances

Deployment created

Description

View template

Portal for ArcGIS on a single machine

This template creates a single-machine portal.

arcgis-portal-singlemachine.template.json

Portal for ArcGIS on two machines for high availability

This template creates a portal that contains a primary and secondary instance.

arcgis-portal-ha.template.json

Single-machine ArcGIS Data Store (relational store, spatiotemporal big data store, object store, or graph store)

Creates one type of ArcGIS Data Store on a single EC2 instance. Run this template for each different single-machine data store type you require.

arcgis-datastore-singlemachine.template.json

ArcGIS Data Store in primary-standby mode

Creates a relational ArcGIS Data Store on two EC2 instances for high availability.

arcgis-datastore-primarystandby.template.json

ArcGIS Data Store in cluster mode

Creates an ArcGIS Data Store spatiotemporal big data store, object store, or graph store in cluster mode. Define the number of instances in the cluster (minimum of 3). Run this template for each different data store type cluster that you require.

For the spatiotemporal big data store, EC2 instances are deployed in an AWS Auto Scaling group.

arcgis-datastore-cluster.template.json

ArcGIS Data Store spatiotemporal big data store in cluster mode with separate coordinator and data role instances

Creates a spatiotemporal big data store in cluster mode and allows you to define how many instances in the cluster fill the coordinator role and how many fill the data role.

arcgis-datastore-cluster-enhanced.template.json

Single-machine ArcGIS Server site

Creates ArcGIS GIS Server, ArcGIS Image Server, or ArcGIS Knowledge Server sites containing one EC2 instance. The type of site can depends on the license you provide when you run the template.

ArcGIS GIS Server and ArcGIS Image Server can be stand-alone or federated with ArcGIS Enterprise. A GIS Server site can be used for the hosting server. ArcGIS Knowledge Server sites must be federated with ArcGIS Enterprise.

arcgis-server-singlemachine.template.json

Multiple-machine ArcGIS Server site for high availability

Creates GIS Server, Image Server, or Knowledge Server sites containing the number of EC2 instances that you specify. Instances are deployed in an AWS Auto Scaling group. The type of site depends on the license you provide when you run the template.

ArcGIS GIS Server and ArcGIS Image Server sites can be standalone sites or federated with ArcGIS Enterprise. ArcGIS Knowledge Server sites must be federated with ArcGIS Enterprise.

arcgis-server-ha.template.json

Single-machine ArcGIS GeoEvent Server site

Creates a ArcGIS GeoEvent Server site containing one EC2 instance.

You can use the site as a stand-alone GeoEvent Server, or you can federate the site with ArcGIS Enterprise.

arcgis-geoevent-server-singlemachine.template.json

Single-machine ArcGIS Mission Server site

Creates an ArcGIS Mission Server site composed of one EC2 instance.

ArcGIS Mission Server sites must be federated with an ArcGIS Enterprise deployment.

arcgis-mission-server-singlemachine.template.json

Multiple-machine ArcGIS Mission Server site for high availability

Creates an ArcGIS Mission Server site composed of the number of EC2 instances that you specify.

ArcGIS Mission Server sites must be federated with an ArcGIS Enterprise deployment.

arcgis-mission-server-ha.template.json

Single-machine ArcGIS Notebook Server site

Creates an ArcGIS Notebook Server site composed of one EC2 instance.

ArcGIS Notebook Server sites must be federated with an ArcGIS Enterprise deployment.

arcgis-notebook-server-singlemachine.template.json

Multiple-machine ArcGIS Notebook Server site for high availability

Creates an ArcGIS Notebook Server site composed of the number of EC2 instances running Linux that you specify. Instances are deployed in an AWS Auto Scaling group.

ArcGIS Notebook Server sites must be federated with an ArcGIS Enterprise deployment.

arcgis-notebook-server-ha.template.json

Single-machine ArcGIS Video Server site

Creates an ArcGIS Video Server site containing one EC2 instance.

ArcGIS Video Server sites must be federated with an ArcGIS Enterprise deployment.

arcgis-video-server-singlemachine.template.json

Single-machine ArcGIS Workflow Manager site

Creates an ArcGIS Workflow Manager Server site composed of one EC2 instance.

ArcGIS Workflow Manager Server sites must be federated with an ArcGIS Enterprise deployment.

You must restart ArcGIS Workflow Manager after you federate the site with ArcGIS Enterprise.

arcgis-workflow-manager-singlemachine.template.json

Multiple-machine ArcGIS Workflow Manager site for high availability

Creates an ArcGIS Workflow Manager Server site composed of the number of EC2 instances that you specify.

ArcGIS Workflow Manager Server sites must be federated with an ArcGIS Enterprise deployment.

You must restart ArcGIS Workflow Manager on each EC2 instance in the site after you federate it with ArcGIS Enterprise.

arcgis-workflow-manager-ha.template.json

Federate an ArcGIS Server site

Use this template to add the hosting server and to federate sites with ArcGIS Enterprise.

arcgis-server-federate.template.json

Templates to register a database

You can run one of the following CloudFormation templates to create a database service, create an enterprise geodatabase in it, and register the database with an ArcGIS Server site. Load data into the database to use as a data source for map services, feature services, or image services that reference registered data.

The ArcGIS Server site must exist before you run any of these templates.

Templates to register a database data store

Deployment created

Description

View template

Enterprise geodatabase in Amazon Aurora (PostgreSQL-compatible edition)

Creates an enterprise geodatabase in an Amazon Aurora (PostgreSQL-compatible edition) instance and registers it with the GIS Server or Image Server that you specify.

arcgis-egdb-aurorapostgres.template.json

Enterprise geodatabase in Amazon Relational Database Service (RDS) for PostgreSQL

Creates an enterprise geodatabase in an Amazon RDS for PostgreSQL instance and registers it with the GIS Server or Image Server that you specify.

arcgis-egdb-postgres.template.json

Enterprise geodatabase in Amazon RDS for SQL Server

Creates an enterprise geodatabase in an Amazon RDS for SQL Server instance and registers it with the GIS Server or Image Server that you specify.

arcgis-egdb-sqlserver.template.json

Templates to create a custom Amazon Machine Image

The templates listed below allow you to choose the base AMI that you start with, which ArcGIS Enterprise components the image contains, and which operating system to use. Confirm that the operating system and version are supported for the ArcGIS Enterprise components you include on the image.

When you create an AMI with a Microsoft Windows operating system, you can include ArcGIS Pro on the image.

Templates to create custom AMIs

Type of custom Amazon Machine Image created

View template

Create an AMI with a Linux operating system and ArcGIS Enterprise components.

arcgis-ami-linux.template.json

Create an AMI with a Microsoft Windows operating system, ArcGIS Enterprise, and ArcGIS Pro.

arcgis-ami-windows.template.json

Templates to upgrade deployments

If you created a deployment using the one of the deployment templates listed above or used the ArcGIS Enterprise Cloud Builder for Amazon Web Services app to create the deployment, you can use the corresponding upgrade CloudFormation template to upgrade.

See ArcGIS upgrades on Amazon Web Services for more information about how to upgrade deployments based on how and when they were created.

Templates to upgrade deployments

Deployment upgraded

View template

ArcGIS Enterprise components on a single machine

arcgis-enterprise-allinone-upgrade.template.json

ArcGIS Enterprise components duplicated on two machines

arcgis-enterprise-ha-upgrade.template.json

Portal for ArcGIS on a single machine

arcgis-portal-singlemachine-upgrade.template.json

Portal for ArcGIS on two machines

arcgis-portal-ha-upgrade.template.json

Single machine ArcGIS Server site (ArcGIS GIS Server, ArcGIS Image Server, or ArcGIS Knowledge Server)

arcgis-server-singlemachine-upgrade.template.json

Multiple machine ArcGIS Server site (ArcGIS GIS Server, ArcGIS Image Server, or ArcGIS Knowledge Server)

arcgis-server-ha-upgrade.template.json

ArcGIS Data Store on a single machine (relational store, spatiotemporal big data store, object store, or graph store)

arcgis-datastore-singlemachine-upgrade.template.json

Primary and standby ArcGIS Data Store machines (relational store or pre-11.5 graph store)

arcgis-datastore-primarystandby-upgrade.template.json

Cluster of ArcGIS Data Store machines (spatiotemporal big data store, object store, or graph store)

arcgis-datastore-cluster-upgrade.template.json

Cluster of ArcGIS Data Store spatiotemporal big data store machines created with specific roles

arcgis-datastore-cluster-enhanced-upgrade.template.json

Single-machine ArcGIS GeoEvent Server site

arcgis-geoevent-server-singlemachine-upgrade.template.json

Single-machine ArcGIS Mission Server site

arcgis-mission-server-singlemachine-upgrade.template.json

Multiple-machine ArcGIS Mission Server site

arcgis-mission-server-ha-upgrade.template.json

Single-machine ArcGIS Notebook Server site

arcgis-notebook-server-singlemachine-upgrade.template.json

Multiple-machine ArcGIS Notebook Server site

arcgis-notebook-server-ha-upgrade.template.json

Single-machine ArcGIS Video Server site

arcgis-video-server-singlemachine-upgrade.template.json

Single-machine ArcGIS Workflow Manager site

arcgis-workflow-manager-singlemachine-upgrade.template.json

Multiple-machine ArcGIS Workflow Manager site

arcgis-workflow-manager-ha-upgrade.template.json