Skip To Content

Deploy ArcGIS Data Store on one machine using CloudFormation

The Esri arcgis-datastore-singlemachine.template.json Amazon Web Services (AWS) CloudFormation template creates one type of ArcGIS Data Store (relational, tile cache, or spatiotemporal big data store) on a single Amazon Elastic Compute Cloud (EC2) instance.

This template creates the following architecture in Amazon Web Services:

Relational, tile cache, or spatiotemporal big data store on one EC2 instance configured with an existing ArcGIS GIS Server site


Certain icons in the diagram are used with permission from Amazon Web Services.

Keep the following in mind when using this template:

  • By default, relational and data store backup files are written to the EC2 instance where ArcGIS Data Store is running. After you launch this stack, use the ArcGIS Data Store configurebackuplocation utility to change the backup location for a relational or tile cache data store and to set a location for spatiotemporal big data store backups.
  • Tile cache data stores created with this template are configured in primary-standby mode, not cluster mode. If you later decide to add machines to the tile cache data store, the mode it runs in affects the number of machines you can add.

Use this template as part of creating an ArcGIS Enterprise deployment as described in Deploy ArcGIS Enterprise components on separate machines using CloudFormation.


Prerequisites can be grouped by the items—such as files and accounts—that you must obtain and the tasks you must perform before running the CloudFormation template.

Required items

You need the following before running this template:

  • An Amazon Web Services account.

    The account must have access to basic AWS services such as CloudFormation, Amazon Elastic Compute Cloud (EC2), Amazon Virtual Private Cloud (VPC), Amazon Simple Storage Service (S3), Systems Manager, Amazon CloudWatch, Lambda, AWS Identity and Access Management (IAM), Amazon DynamoDB, Secrets Manager, AWS Certificate Manager, and Amazon Relational Database Service (RDS).

  • If you create a deployment on Ubuntu EC2 instances in AWS GovCloud, you need an AMI ID. If you want to use the base canonical Ubuntu AMI, follow the instructions in Esri Amazon Web Services CloudFormation templates to identify the ID.
  • An Amazon Virtual Private Cloud (VPC) and subnets.

    You can use one of the following CloudFormation templates to create a VPC: VPC with two public subnets or VPC with two public and private subnets with a NAT Gateway.

  • The arcgis-datastore-singlemachine.template.json CloudFormation template.

Required tasks

Complete the following tasks before running this template:

  • You must have an ArcGIS GIS Server site that will be used as a hosting server for an ArcGIS Enterprise portal. Be sure the site doesn't already have the same type of ArcGIS Data Store registered to it that you will create with this template.

    You can use the single machine ArcGIS Server site template or multiple machine ArcGIS Server site template to create the site.

  • Configure passwords in AWS Secrets Manager (optional but recommended).

    You can configure the passwords for accounts such as the site administrator username and the Windows arcgis user password in AWS Secrets Manager. This provides you with a secret Amazon Resource Name (ARN). Use the ARN in place of a password in the template parameters when you launch a stack. If you don't use AWS Secrets Manager for storing passwords, you must type passwords in plain text in the template parameter when launching the stack.


    When creating a secret ARN in AWS Secrets Manager for a password to be used with Esri CloudFormation templates, you must use the Other types of secrets secret type and use the Plaintext option. For more information on creating an Amazon Resource Name for passwords, see AWS CloudFormation and ArcGIS.


By default, CloudFormation deletes partially created resources if stack creation fails. This is helpful because it removes unusable deployments from your account, but it can make it difficult to troubleshoot. To retain the stack in its failed state, disable the Rollback on failure CloudFormation stack creation option before launching the stack. See Setting AWS CloudFormation options in the AWS help for more information.


Refer to the following tables for descriptions of the parameters used in this CloudFormation template. Tables are grouped by parameter type.

Amazon EC2 Configuration

Parameter nameRequired?Parameter description

Platform Type


Choose the operating system platform. Supported types are as follows:

  • Windows
  • Linux

For specific operating system versions, see Operating systems supported when using CloudFormation to ArcGIS deploy on AWS.

EC2 Instance AMI ID


You can leave this parameter value empty. If you do, CloudFormation templates will use the latest Amazon Machine Image (AMI) ID for Microsoft Windows Server 2019 or Ubuntu Server 20.04 LTS based on the type of platform you selected.


You cannot leave this parameter empty if you deploy in AWS GovCloud on a Linux platform. See Esri Amazon Web Services CloudFormation templates for instructions for finding the ID for the base Ubuntu AMI from Canonical. If you deploy on a supported Linux operating system other than Ubuntu, you can find the AMI ID using AWS Management Console.

To use your own custom AMI, type the AMI ID using one of the following:

  • Provide the AMI ID in the format 'ami-xxxxx'.
  • If you stored the AMI ID in the AWS SSM parameter store, provide the SSM parameter name in the format AWS'{{resolve:ssm:[a-zA-Z0-9_.-/]+:\d+}}'.

If you use a custom AMI, ensure that it meets the following requirements:

  • EC2 instance metadata service (with either version V2 or V1) must be activated.
  • The latest version of AWS Systems Manager (SSM) Agent must be installed.
  • If the custom AMI has a Windows operating system, AWS Tools for PowerShell must be installed.

EC2 Instance Keypair Name


Choose an EC2 keypair name to allow remote access to EC2 instances.

Elastic IP Address Allocation ID


Provide the Allocation ID of an elastic IP address in this format, eipalloc-XXXXXXXX.

You need an elastic IP address to map the site domain name to the elastic IP address and access the EC2 instance via RDP/SSH from outside of the AWS environment.

Leave this parameter empty if you don't want to assign an elastic IP address to the EC2 instance.

Amazon VPC Configuration

Parameter nameRequired?Parameter description



Choose a VPC ID.


This must be the same VPC as the ArcGIS GIS Server site to which you're adding this data store.

Subnet ID 1


Choose a subnet ID. The subnet ID that you select must be within the VPC you have selected above.

If you used an Esri CloudFormation template to create the VPC, you can get the subnet ID from that template's output parameters.

ArcGIS Server Configuration

Parameter nameRequired?Parameter description

Site Administrator User Name


Provide a username for the ArcGIS Server primary site administrator of the ArcGIS GIS Server site that will be used as the portal's hosting server.

Site Administrator User Password


Provide the password for the ArcGIS Server primary site administrator. You can either type a plain text password or the ARN of your secret ID from AWS Secrets Manager. For more information on creating an Amazon Resource Name for passwords, see AWS CloudFormation and ArcGIS.

The password or secret ID you provide must match that of the existing primary site administrator.

ArcGIS Server EC2 Instance ID


Choose an EC2 instance ID where your ArcGIS Server site is configured.

If you are registering the database with a multimachine ArcGIS Server site, you can choose any EC2 instance ID from the ArcGIS Server site. Do not choose a file server EC2.

ArcGIS Data Store Configuration

Parameter nameRequired?Parameter description



Choose the ArcGIS Data Store type. Valid values are relational, spatiotemporal, or tileCache.

EC2 Instance Type


Choose an EC2 instance type for the ArcGIS Data Store instance. The default is m5.2xlarge.

The instance will be configured with the AWS Auto Recovery feature.

Instances are configured in an Auto Scaling group.

EC2 Instance Root Drive Disk Space


Provide the size of the root drive in GB. The default is 100 GB. Minimum is 100 GB. Maximum is 1024 GB.

Windows arcgis user password


Provide a password for the arcgis user. The arcgis user is a local Windows login used to run the ArcGIS software services; therefore, this password is only required if you deploy on Windows.

You can either enter a plain text password or the ARN of your secret ID from AWS Secrets Manager.

It's a best practice to manage your passwords in AWS Secrets Manager. For information on creating an Amazon Resource Name for passwords, see AWS CloudFormation and ArcGIS.


When your stack is created successfully, you can see the following output parameters on the Outputs tab of the CloudFormation stack in AWS Management Console.

Output nameOutput description


This is the URL for the Amazon CloudWatch logs where all deployment logs are stored. You can refer to these logs for troubleshooting purposes if your deployment fails.


This is the Stop Stack Lambda function URL. You can use this lambda function to stop all EC2 instances in the stack.


This is the Start Stack Lambda function URL. You can use this lambda function to start all EC2 instances in the stack that you previously stopped.


The following are important points to consider after creating a CloudFormation stack containing ArcGIS deployments:

  • Do not delete any AWS resource created by this CloudFormation template. If you want to know what AWS resources have been created by this template, refer to the Resources tab of this stack in the AWS Management Console. Each resource created by an Esri CloudFormation template also has metadata tags. However, some of the resources do not show tags in the AWS Management Console.
  • You can use the AWS Lambda functions that appear in your stack outputs (listed in the Outputs section of this page) to stop EC2 instances in this stack when they are not in use and start them again when required. These functions are useful to help you manage costs.

    When you run the Lambda function to stop the EC2 instances in the deployment, the function returns a message that the instances are stopped. However, if the instances participate in an Auto Scaling group, the function must also detach the instances from the group. This can take up to 10 minutes to complete. Therefore, wait at least 10 minutes before you run the Lambda start function to restart the deployment.

  • If you use AWS Secrets Manager for passwords, such as the site administrator user password or the Windows arcgis user password, and later (after you create the deployment) you change those passwords, be sure you update the appropriate AWS Secrets Manager ARN's with the updated passwords.


If you observe any failures when creating this CloudFormation stack, see Troubleshoot ArcGIS deployments on AWS.