ArcGIS Enterprise Cloud Builder for AWS

Use ArcGIS Enterprise Cloud Builder for Amazon Web Services (AWS) to simplify the creation of ArcGIS Enterprise deployments on AWS.

ArcGIS Enterprise Cloud Builder for AWS includes a graphical user interface application and the ArcGIS Enterprise Cloud Builder Command Line Interface for Amazon Web Services utility, which allows you to automate cloud deployments of ArcGIS Enterprise. Before you use either of these, confirm you meet the prerequisites, and download the ArcGIS Enterprise Cloud Builder for Amazon Web Services file from My Esri.

Both the app and command line interface use Esri AWS CloudFormation templates to deploy software stacks.

Cloud Builder for AWS app

Use the ArcGIS Enterprise Cloud Builder for Amazon Web Services app for an interactive experience to provision resources and deploy ArcGIS Enterprise on AWS. Decide what ArcGIS components you need before deploying; the ArcGIS Enterprise Cloud Builder for Amazon Web Services app does not currently include functionality to add components to an existing deployment.

Deploy ArcGIS Enterprise on a single Amazon Elastic Compute Cloud (EC2) instance and the federated servers you require.
Create a highly available ArcGIS Enterprise deployment and the federated servers you require.
Create a stand-alone ArcGIS Server site.

After you install Cloud Builder, you can open the app from the Start menu on your computer.

Note:

Be aware of the following when you use the Cloud Builder for AWS app:

When you create a deployment, an Amazon Simple Storage Service (S3) bucket is created in the Amazon us-east-1 region to store resources for the deployment. Cloud Builder manages this deployment bucket. Do not delete, rename, or modify this S3 bucket or its contents, because doing so can result in the deployment being out of sync with Cloud Builder.
If you federate ArcGIS Server sites after you use the Cloud Bulder app to deploy ArcGIS Enterprise, Cloud Builder will not recognize or display these as part of the deployment. Also, once you add components outside of Cloud Builder, you cannot use Cloud Builder to upgrade the deployment.

Set preferences (optional)

You can set a default AWS region and a default size for the root drives of the Amazon EC2 instances in the deployment. As you move through the app, the region and drive size options are prepopulated with the preference values you set.

To set these preferences, open the app, sign in to your AWS account, and click the Preferences link at the bottom of the Deployments page of the app.

Manage deployments

Deployments you create using ArcGIS Enterprise Cloud Builder for Amazon Web Services appear in a list of existing deployments when you open the app. From this list, you can do the following:

Stop or start a deployment.
Access and view information about the deployment.
Create a deployment that is similar to an existing deployment.
Delete a deployment and its resources.
Upgrade a deployment (applies to specific ArcGIS versions created using the Cloud Builder app).

Deployments you create using other methods do not appear in this list.

Cloud Builder Command Line Interface for AWS

The ArcGIS Enterprise Cloud Builder Command Line Interface (CLI) for Amazon Web Services utility allows you to automate cloud deployments of ArcGIS Enterprise.

To create an ArcGIS Enterprise deployment on AWS using ArcGIS Enterprise Cloud Builder CLI for AWS requires two JSON files, your Microsoft Windows computer's command prompt, and the AWS Management Console. The two JSON files—one to prepare for installation and another to deploy—can be modified from the sample files available in the Configuration folder in the Cloud Builder installation location. Always keep the configuration files in the Cloud Builder installation location.

Use a text editor, such as Notepad++, to edit the JSON files. After you alter the JSON files, open a Command Prompt console, change directories to the folder where you extracted Cloud Builder, and run the Cloudbuilder.exe command. Specify the correct JSON file and the required command to prepare (PREP) or create (CREATE) a deployment.

Cloudbuilder.exe PREP -j <prepfilename.json>
Cloudbuilder.exe CREATE -j <createfilename.json>

The other commands used with ArcGIS Enterprise Cloud Builder CLI for AWS do not require JSON files. They are as follows:

Cloudbuilder.exe LIST --aws-access-key <access key> --aws-secret-access-key <secret access key> or Cloudbuilder.exe LIST --aws-profile-name <aws profile name>
Cloudbuilder.exe STOP -d <deployment name> --aws-access-key <access key> --aws-secret-access-key <secret access key> or Cloudbuilder.exe STOP -d <deployment name> --aws-profile-name <aws profile name>
Cloudbuilder.exe START -d <deployment name> --aws-access-key <access key> --aws-secret-access-key <secret access key> or Cloudbuilder.exe START -d <deployment name> --aws-profile-name <aws profile name>
Cloudbuilder.exe DELETE -d <deployment name> --aws-access-key <access key> --aws-secret-access-key <secret access key> or Cloudbuilder.exe DELETE -d <deployment name> --aws-profile-name <aws profile name>
Cloudbuilder.exe {-v | --version}
Cloudbuilder.exe {-h | --help}

The PREP command automates several tasks that you are required to complete before creating a deployment. It creates a network stack and Amazon Simple Storage Service (S3) bucket for your deployment, uploads all necessary authorization files and the SSL certificate to the bucket, and imports your SSL certificate to AWS Certificate Manager. The PREP command is only necessary the first time you create a specific ArcGIS Enterprise deployment, if you have not already done these steps manually.

The CREATE command creates an ArcGIS Enterprise deployment and can create and federate one additional machine for each ArcGIS Server licensing role you specify. Once you have run the command to create a deployment, you can run it later with an updated file to add more sites to the deployment. A file server instance is created for the deployment.

The LIST command returns a list of all deployments in your account that you created using the ArcGIS Enterprise Cloud Builder for AWS app or command line interface. The list contains five columns: Deployment Name, AWS Region, ArcGIS Version, Deployment Status, and Deployment State.

The STOP command stops all Amazon EC2 instances associated with the deployment you specify. You can only use this command to stop deployments created using the ArcGIS Enterprise Cloud Builder for AWS app or command line interface.

The START command starts all Amazon EC2 instances associated with the deployment you specify. You can only use this command to start deployments created using the ArcGIS Enterprise Cloud Builder for AWS app or command line interface.

The DELETE command deletes your deployment and associated AWS resources. It can only delete a deployment created using the ArcGIS Enterprise Cloud Builder CLI for AWS or ArcGIS Enterprise Cloud Builder for AWS app.

The version or -v option returns the current version of ArcGIS Enterprise Cloud Builder CLI for AWS.

The help or -h option displays syntax and examples for ArcGIS Enterprise Cloud Builder CLI for AWS commands.

To get started using ArcGIS Enterprise Cloud Builder CLI for AWS to create a deployment, see Prepare deployment resources using the Cloud Builder CLI for AWS PREP command.