Skip To Content

ArcGIS Enterprise Cloud Builder CLI for AWS parameters

When you use ArcGIS Enterprise Cloud Builder Command Line Interface for Amazon Web Services (AWS) to prepare and deploy ArcGIS Enterprise and ArcGIS Server sites, you provide information about the type of deployment you want by providing the location and name of the JSON file containing the settings you need.

Sample files

Several sample JSON files are included with the ArcGIS Enterprise Cloud Builder CLI for AWS file you download from My Esri. The JSON samples represent common deployments. There are separate files for preparatory steps—which you can use when you run the ArcGIS Enterprise Cloud Builder CLI for AWS utility with the PREP command—and files you can use to create the deployment when you run the ArcGIS Enterprise Cloud Builder CLI for AWS utility with the CREATE command.

The following two tables describe the sample files provided with the ArcGIS Enterprise Cloud Builder CLI for AWS utility:

Preparation sample fileDescription
createnetworkvpc.json

Creates an Amazon Virtual Private Cloud (VPC) in the AWS region you specify.

uploadlicensefile.json

Uploads ArcGIS Server licenses and a Portal for ArcGIS license file to an Amazon Simple Storage Service (S3) bucket managed by ArcGIS Enterprise Cloud Builder for Amazon Web Services.

uploadsslcert.json

Uploads an SSL certificate to the Amazon S3 bucket managed by Cloud Builder and imports the SSL certificate to AWS Certificate Manager.

uploadlicenseandcert.json

Uploads ArcGIS Server licenses, a Portal for ArcGIS license, and an SSL certificate to the Amazon S3 bucket managed by Cloud Builder. It also imports the SSL certificate to AWS Certificate Manager.

allprep.json

Creates a VPC and uploads ArcGIS Server licenses, a Portal for ArcGIS JSON file, and an SSL certificate to the Amazon S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS. It also imports the SSL certificate to AWS Certificate Manager.

Creation sample fileDescription
baseenterpriseallinone.json

Deploys base ArcGIS Enterprise on a single machine.

baseenterprisehawithbds.json

Deploys base ArcGIS Enterprise on two machines—a primary and a standby machine—and adds a spatiotemporal big data store.

baseenterpriseallinonewithra.json

Deploys base ArcGIS Enterprise plus a federated ArcGIS Image Server site configured as the portal's raster analysis server.

baseenterprisehawithga.json

Deploys base ArcGIS Enterprise on two machines plus a federated ArcGIS GeoAnalytics Server site configured as the portal's GeoAnalytics server.

baseenterprisehawithih.json

Deploys base ArcGIS Enterprise on two machines plus a federated ArcGIS Image Server site configured as the portal's image hosting server.

baseenterprisehawithnotebook.json

Deploys base ArcGIS Enterprise on two machines plus a federated ArcGIS Notebook Server.

baseenterprisewithmission.json

Deploys base ArcGIS Enterprise on a single machine plus a federated ArcGIS Mission Server.

completeArcGISEnterprise.json

Allows you to create a highly available base ArcGIS Enterprise deployment with all possible federated ArcGIS Server sites.

standalonegeoevent.json

Deploys a stand-alone ArcGIS GeoEvent Server site.

standaloneserver.json

Deploys a stand-alone ArcGIS GIS Server site.

standaloneserverwithsqlegdb.json

Deploys a stand-alone ArcGIS GIS Server site and registers a managed enterprise geodatabase in Amazon Relational Database Service (RDS) for SQL Server.

standaloneserverwithpostgresegdb.json

Deploys a stand-alone ArcGIS GIS Server site and registers a managed enterprise geodatabase in Amazon RDS for PostgreSQL.

You can copy and alter these files using a text editor or create your own JSON files. If you use the samples, replace sample settings with values specific to your deployment. You can also change which parameters are present in the sample files.

Parameters in the JSON file are grouped together under section (node) headings. These parameters and their groupings are described in the remainder of this topic.

AWS credentials and region

To connect to Amazon Web Services, the command needs your AWS credentials. Credentials can be the access key and secret key for your AWS account, or the AWS profile name for your account. These credentials are required whenever you run the ArcGIS Enterprise Cloud Builder CLI for AWS utility, and are grouped under the "AWSCredentials" section.

You also need to specify the AWS region in which you want to deploy. This region must be the same for all components of your deployment.

ParameterDescriptionRequired or optional
"AWSAccessKey"

The access key for your AWS account.

Required if you do not specify the "AWSProfileName" parameter.

"AWSSecretKey"

The secret key for your AWS account.

Required if you do not specify the "AWSProfileName" parameter.

"AWSProfileName"

The profile name you configured for your AWS account.

Required if you do not specify the "AWSAccessKey" and "AWSSecretKey" parameters.

"AWSRegion"

The AWS region where all parts of your deployment will be created.

Required.

In this example, credentials for authorization are the access and secret keys for the AWS account. The Amazon Elastic Compute Cloud (EC2) instances will be launched in AWS region eu-west-2.

"AWSCredentials": {
    "AWSAccessKey": "AKIAINKWSK6MI4YCPA123",
    "AWSSecretKey": "ABCD1E2fghIJkLmNOPQzZuXHlWHOPhMqrTmPEpV",
    "AWSRegion": "eu-west-2"
   }

In this example, the credentials for authentication are the profile name configured for the AWS account. The EC2 instances will be launched in AWS region us-west-1.

"AWSCredentials": {
    "AWSProfileName": "betavpc",
    "AWSRegion": "us-west-1"
   }

Parameters to use in files for deployment preparation

Before you create a deployment, you must create a VPC and S3 deployment bucket managed by ArcGIS Enterprise Cloud Builder for AWS and upload your SSL certificate and ArcGIS software licenses to the S3 bucket. Set parameters in a prep .json file to complete these steps.

Network stack

The "NetworkStack" section is an optional section of the prep file that allows you to create a VPC.

In this example, the utility will create a VPC in AWS zones eu-west-2b and eu-west-2a and assign it a name tag of MyEnterpriseVPC.

"NetworkStack": {
		"StackName": "MyEnterpriseVPC",
		"AZs": "eu-west-2b,eu-west-2a",
		"CreateFlag": true
	}

The following table describes each of the parameters you can use in the "NetworkStack" section:

ParameterDescriptionRequired or optional
"StackName"

A unique name tag for your VPC to help you identify it.

Optional; if not specified, a VPC is created with the name tag arcgis-vpc.

"AZs"

Specify two AWS availability zones for the VPC. The zones must be within the region you specified under the "AWSCredentials" node.

The "AZs" parameter is required if you include the "NetworkStack" node in your file.

"CreateFlag"

Specifies whether to create a VPC (true) or not (false).

The "CreateFlag" parameter is required if you include the "NetworkStack" node in your file.

ArcGIS Enterprise files

The "ArcGISEnterpriseFiles" section contains information about the licensing and SSL files the utility needs to create your deployment.

ArcGIS Server license files can be .prvc or .ecp files. Portal for ArcGIS licenses are in .json files.

SSL files must be .pfx files.

The following is an example "ArcGISEnterpriseFiles" section with all possible parameters specified:

"ArcGISEnterpriseFiles": {
	           "PortalLicense": "C:\\Licenses\\portal.json",
            "ServerLicense": "C:\\Licenses\\Server.prvc",
            "GeoAnalyticsLicense": "C:\\Licenses\\Server_GeoAnalytics.prvc",
            "NotebookServerLicense": "C:\\Licenses\\Notebook_Server.prvc",
            "MissionServerLicense": "C:\\Licenses\\Mission_Server.prvc",
            "ImageServerLicense": "C:\\Licenses\\Server_Image.prvc",
            "RasterAnalyticsLicense": "C:\\Licenses\\Server_Image.prvc",
            "ImageHostingLicense": " C:\\Licenses\\Server_Image.prvc ",
            "GeoEventLicense": " C:\\Licenses\\Server_GeoEvent.prvc.prvc",
            "SSLCertificateFile": "C:\\SSLCerts\\wildcard_webgistesting_net.pfx",
		          "SSLCertPassword": "abc123"
	}

The following table contains descriptions of each parameter you can use in the "ArcGISEnterpriseFiles" node:

ParameterDescriptionRequired or optional
"PortalLicense"

Your Portal for ArcGIS license file (.json).

Specify the physical path to the license file on local disk so the utility can upload it to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required if you deploy ArcGIS Enterprise.

"ServerLicense"

Your ArcGIS GIS Server license file.

Required if you deploy ArcGIS Enterprise or a federated or stand-alone ArcGIS GIS Server site.

"ImageServerLicense"

Your ArcGIS Image Server license file.

Required if you deploy a federated or stand-alone ArcGIS Image Server site.

"GeoAnalyticsLicense"

Your ArcGIS GeoAnalytics Server license file.

Required if you deploy an ArcGIS GeoAnalytics Server site.

"NotebookServerLicense"

Your ArcGIS Notebook Server license file.

Required if you deploy an ArcGIS Notebook Server site.

"MissionServerLicense"

Your ArcGIS Mission Server license file.

Required if you deploy an ArcGIS Mission Server site.

"RasterAnalyticsLicense"

Your ArcGIS Image Server license file.

Required if you deploy a federated ArcGIS Image Server.

"ImageHostingLicense"

Your ArcGIS Image Server license file.

Required if you deploy a federated ArcGIS Image Server.

"GeoEventLicense"

Your ArcGIS GeoEvent Server license file.

Required if you deploy a federated or stand-alone ArcGIS GeoEvent Server.

"SSLCertificateFile"

The SSL certificate file issued to your site domain.

Specify the physical path to the SSL certificate on local disk so the utility can upload it to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required to upload the SSL certificate.

"SSLCertPassword"

The password for the SSL certificate.

Required to upload the SSL certificate.

Parameters to use in files for deployment creation

To create a deployment, you need to provide information about the software and hardware you want to include in the deployment. Parameters are grouped under the nodes described in the following sections.

Deployment details

At the top of the file, specify a name that will be used for each of the Amazon Elastic Compute Cloud instances (machines) in your deployment, the ArcGIS software version you want to deploy (10.6 or later release), and which operating system (either Microsoft Windows or Ubuntu Server) to use for the EC2 instances you deploy. All of these parameters are required except "AMIid".

"DeploymentDetails": {
       "DeploymentName": "<name_to_append_to_machines_in_aws_deployment">,
       "ArcGISVersion": "<10.6 | 10.6.1 | 10.7 | 10.7.1 | 10.8 | 10.8.1 | 10.9>",
       "OperatingSystem": "<Windows | Ubuntu>",
       "AMIid":  “ami-xxxxxx”
   }

The "DeploymentName" parameter must start with an alpha character, can contain only alphanumeric characters, and must be at least three characters in length.

The “OperatingSystem” parameter specifies the operating system to be used in ArcGIS deployments. For Windows it uses Microsoft Windows Server 2019 and for Ubuntu it uses Ubuntu Server 18.04 LTS.

The “AMIId” parameter is optional, but if you do specify it, it must be defined under the “DeploymentDetails” node. Specify the “AMIId” value in the following format: ‘ami-xxxxxx’. If you stored the AMI ID in the AWS SSM parameter store, you can specify the “AMIId” value in the following format: ‘{{resolve:ssm:[a-zA-Z0-9_.-/]+:\d+}}'. If you don't know what AMI to use, don’t specify this parameter, and the ArcGIS Enterprise Cloud Builder CLI for AWS tool will use the latest AMI ID for Windows or Ubuntu based on the “OperatingSystem” parameter value.

Note:

You must specify a value for the “AMIId” parameter if you deploy in Amazon Web Services GovCloud with an Ubuntu operating system.

In this example, the names of all machines in the deployment will start with testservers. Because an AMI ID is not specified, the tool will use the latest Ubuntu AMI ID.

"DeploymentDetails": {
       "DeploymentName": "testservers",
       "ArcGISVersion": "10.9",
       "OperatingSystem": "Ubuntu" 
   }

CloudFormation parameters

The parameters required by the Amazon Web Services CloudFormation templates are organized under the following nodes:

  • "Default"—Parameters set here apply to all parts of the deployment. Parameters set under default can be omitted from the other nodes.
  • "BaseEnterprise"—Parameters set in this section apply only to the base ArcGIS Enterprise deployment.
  • "GeoAnalytics"—Parameters set in this section apply only to a federated ArcGIS GeoAnalytics Server site.
  • "NotebookServer"—Parameters set in this section apply only to a federated ArcGIS Notebook Server site.
  • "MissionServer"—Parameters set in this section apply only to a federated ArcGIS Mission Server site.
  • "RasterAnalytics"—Parameters set in this section apply only to federated or stand-alone ArcGIS Image Server sites.
  • "ImageHosting"—Parameters set in this section apply only to federated ArcGIS Image Server sites to be used as the portal's image hosting server.
  • "Server"—Parameters set in this section apply only to federated or stand-alone ArcGIS GIS Server sites.
  • "ImageServer"—Parameters set in this section apply only to federated or stand-alone ArcGIS Image Server sites.
  • "GeoEvent"—Parameters set in this section apply only to a federated or stand-alone ArcGIS GeoEvent Server site.
  • "Spatiotemporal"—Parameters set in this section apply only to a spatiotemporal big data store component of an enterprise deployment.
  • "SQLEGDB"—Parameters set in this section apply only to an enterprise geodatabase in Amazon RDS for SQL Server.
  • "PostgresEGDB"—Parameters set in this section apply only to an enterprise geodatabase in Amazon RDS for PostgreSQL.
  • "AuroraEGDB"—Parameters set in this section apply only to an enterprise geodatabase in Amazon Aurora PostgreSQL.

Note:

You must include a node for every part of the deployment you want created. For example, if you want to create a base ArcGIS Enterprise deployment, a federated ArcGIS GeoAnalytics Server site, and a federated ArcGIS GIS Server site, you must have the "BaseEnterprise", "GeoAnalytics", and "Server" nodes in your configuration file, and these nodes must contain at least one parameter. For example, even if you set the "Federate" and "ServerLicenseFileKeyName" parameters under the "Default" node, you must include at least one of these under the "Server" node; if you do not, the utility will not create a federated ArcGIS GIS Server site.

VPC settings must be defined under the "Default" node. You can use the "VPCId", "Subnet1", and "Subnet2" parameters to define your VPC, or, if you want to reuse a VPC from an existing deployment created with this tool or an Esri CloudFormation template, you can specify the name of the deployment under the "NetworkStackName" parameter instead. The following are descriptions of these parameters:

ParameterDescriptionRequired or optional
"VPCId"

When you created your VPC, AWS assigned it an ID in the format vpc-xxxxxxxx. Provide the ID for your VPC here.

If you use the ArcGIS Enterprise Cloud Builder CLI for AWS utility to prepare your deployment, this ID is listed in the output file created when you run the utility with the PREP command.

Required if you do not specify the "NetworkStackName" parameter.

"Subnet1"

The ID for one of the subnets in your VPC.

If you use the ArcGIS Enterprise Cloud Builder CLI for AWS utility to prepare your deployment, this ID is listed in the output file created when you run the utility with the PREP command.

Required if you do not specify the "NetworkStackName" parameter.

"Subnet2"

The ID for the second subnet in your VPC.

If you use the ArcGIS Enterprise Cloud Builder CLI for AWS utility to prepare your deployment, this ID is listed in the output file created when you run the utility with the PREP command.

Required if you do not specify the "NetworkStackName" parameter.

"NetworkStackName"

The name tag assigned to an existing VPC.

Required if you do not specify the "VPCId", "Subnet1", and "Subnet2" parameters.

Other parameter values defined under the "Default" node are applicable to some or all of the other nodes in the JSON file. Esri recommends that you use the Default node to define parameters and values that are common across multiple nodes in the deployment. This shortens the configuration file and avoids repetition of parameters and values. For example, if you deploy a base ArcGIS Enterprise and federated ArcGIS GeoEvent Server, and use a wildcard SSL certificate, specify the "SSLCertificateFileKeyName" and "SSLCertificatePassword" parameters under the "Default" node because all the machines in the deployment will use the same certificate.

As shown in the following example, the "VPCId", "Subnet1", and "Subnet2" parameters are used to define the VPC. The root drive size ("InstanceDriveSize"), S3 bucket, administrator user name and password, and the password for the software services ("arcgisUserPassword") apply to all parts of this deployment. Since all ArcGIS Server sites in the deployment will be federated with the portal, "Federate": true is also included under the "Default" node.

"CloudFormationParameters":{   
    "Default" :{               
        "VPCId": "vpc-b33fecd5",
        "Subnet1": "subnet-7a709d1c",
        "Subnet2": "subnet-26f0f76f",   
        "InstanceDriveSize": "300",
        "KeyPairName": "StackTest_Mine",      
        "SiteadminUserName": "admin",
        "SiteadminPassword": "changeit",    
        "arcgisUserPassword": "Change@1234",
        "PostInstallationScript": "none",
        "Federate": true
    }
}

If you define parameter values in a specific deployment node, the value you specify in that node is used for that part of the deployment. For example, if you define the "InstanceType" parameter in both the "BaseEnterprise" and "Default" nodes, the "InstanceType" value defined in the "BaseEnterprise" node is used for the ArcGIS Enterprise base deployment machines, but the "InstanceType" value defined for the "Default" node is used for the ArcGIS GeoAnalytics Server, ArcGIS GIS Server, ArcGIS Image Server, and ArcGIS GeoEvent Server sites you deploy using the same JSON file.

Parameters for base ArcGIS Enterprise

Parameter values you specify under the "BaseEnterprise" node apply only to ArcGIS Enterprise stacks created with the Esri CloudFormation templates that deploy ArcGIS Enterprise. You can use any of the following parameters for the base ArcGIS Enterprise portion of a deployment:

ParameterDescriptionRequired or optional
"Type"

Possible values are "AllInOne".) to deploy all ArcGIS Enterprise components on a single Amazon Elastic Compute Cloud instance or "HA" to create a highly available deployment on two instances.

Required.

This parameter must be specified under the "BaseEnterprise" node, not the "Default" node.

"KeypairName"

The Amazon Elastic Compute Cloud key pair to allow remote access to the EC2 instances.

Required if you did not specify this under the "Default" node.

"EIPAllocationID"

The allocation ID of the Elastic IP address of the VPC.

Optional.

Required if you deploy the base ArcGIS Enterprise on a single machine. (Set the "Type" parameter to "AllInOne".)

You can specify this parameter under the "Default" node or the "BaseEnterprise" node.

"ELBDNSName"

Specify the domain name server (DNS) name of an existing Elastic Load Balancer (ELB). The ELB must be an application load balancer or classic load balancer.

If you do not want to use an ELB or want to configure it later, do not use this parameter.

Optional.

Applicable only if you create a highly available ArcGIS Enterprise deployment (set the "Type" parameter to "HA").

"InstanceType"

The Amazon Elastic Compute Cloud instance type to use for the ArcGIS Enterprise machine or machines.

Required if you did not specify this under the "Default" node.

"InstanceDriveSize"

The size (in GB) of the C: or root drive of the ArcGIS Enterprise machines.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"PortalLicenseFileKeyName"

The name of the Portal for ArcGIS authorization file object key.

The .json file must be uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required if you did not specify this under the "Default" node.

"UserLicenseTypeID"

In the Portal for ArcGIS license file you receive from Esri, identifiers (IDs) are present for the types of users you are licensed to use in your portal. A subset of those are available for use for the initial administrator.

The IDs present in your file can vary, but typical IDs include (but are not limited to) creatorUT, GISProfessionalStdUT, and editorUT. These IDs are case sensitive, so be sure to type them as shown in your Portal for ArcGIS license .json file.

Optional, but if you do specify this parameter, specify it under the "BaseEnterprise" node, and ensure the user ID exists in the Portal for ArcGIS license file.

"ServerLicenseFileKeyName"

The name of the ArcGIS GIS Server license file for the hosting server. This file must be uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required if you did not specify this under the "Default" node.

"SiteadminUserName"

The user name of the ArcGIS Server primary site administrator and Portal for ArcGIS initial administrator accounts.

Required if you did not specify this under the "Default" node.

"SiteadminUserPassword"

The password for the site administrator account.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Required if you did not specify this under the "Default" node.

"arcgisUserPassword"

The password for the account used to run the ArcGIS Server, Portal for ArcGIS, and ArcGIS Data Store Windows services. The login name is always ArcGIS.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Conditional.

This parameter is required if you deploy on Windows machines (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows") and you did not specify this parameter under the "Default" node.

"ConfigStoreType"

The type of storage location for the ArcGIS Server configuration store and Portal for ArcGIS content directory.

To use an EC2 machine, set this parameter to "FileSystem". To use an S3 bucket for the portal content directory and an S3 bucket and Amazon DynamoDB table for the portal content directory, set this parameter to "CloudStore".

Required if you did not specify this under the "Default" node.

"FileserverInstanceType"

The Amazon Elastic Compute Cloud instance type to use for the file server.

Optional.

Applicable only if you create a highly available ArcGIS Enterprise deployment (set the "Type" parameter to "HA").

"FileserverInstanceDriveSize"

The size (in GB) of the C: or root drive of the ArcGIS Enterprise file server machine.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Optional.

Applicable only if you create a highly available ArcGIS Enterprise deployment (set the "Type" parameter to "HA").

"SiteDomain"

The domain name for your deployment.

If you use AWS Route 53 to manage your domain name servers and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify a subdomain name. If you don't specify a subdomain name, a domain name based on the default naming convention will be used.

If you are not using AWS Route 53 to manage your domain name servers and didn't set the "AWSR53ZoneId" parameter, you must specify a fully qualified domain name for the "SiteDomain" parameter.

If you use your own DNS server to manage your domain name rather than using AWS Route 53, ensure the domain name ("SiteDomain") is mapped to the appropriate Elastic Load Balancer or Elastic IP address in your DNS before running ArcGIS Enterprise Cloud Builder CLI for AWS, so that the domain name is valid at the time of federation. You can create Elastic Load Balancers (using the AWS Management Console or Esri AWS CloudFormation templates) or Elastic IP addresses (using AWS Management Console).

Required if you did not specify this under the "Default" node.

"PortalWebadaptorName"

The web adaptor name for the portal. Access to the portal will be through a URL in the format https://<fully qualified domain name>/<web adaptor name>.

The default value is "portal".

Optional, but if you do specify this parameter, it must be specified under the "BaseEnterprise" node.

"ServerWebadaptorName"

The web adaptor name for the ArcGIS Server site. Access to the ArcGIS Server site will be through a URL in the format https://<fully qualified domain name>/<web adaptor name>.

The default value is "server".

Optional, but if you do specify this parameter, it must be specified under the "BaseEnterprise" node.

"SSLCertificateFileKeyName"

The SSL certificate file object key name. This must be a .pfx file you uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required.

This parameter must be specified under the "BaseEnterprise" node or the "Default" node.

"SSLCertificatePassword"

The password for the SSL certificate.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Required.

This parameter must be specified under the "BaseEnterprise" node or the "Default" node.

"TemplateURL"

To use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional, but if you do specify this parameter, it must be specified under the "BaseEnterprise" node, not the "Default" node.

Parameters for ArcGIS GeoAnalytics Server, ArcGIS Image Server, and ArcGIS GIS Server sites and the raster analysis and image hosting servers

Parameter values you specify under the "GeoAnalytics", "RasterAnalytics", "ImageHosting", "ImageServer", and "Server" nodes use the Esri CloudFormation templates that launch federated or stand-alone ArcGIS Server sites. Note that ArcGIS GeoAnalytics Server sites must always be federated with an ArcGIS Enterprise portal and that to use an ArcGIS Image Server site as a raster analysis server or as an image hosting server, the site must be federated with a portal.

When you create federated ArcGIS GeoAnalytics Server and ArcGIS Image Server sites, the ArcGIS Enterprise Cloud Builder CLI for AWS utility configures these sites as your portal's GeoAnalytics, raster analysis, and image hosting servers, respectively; you do not need to configure this manually.

The following table lists all the possible parameters you can set under the "GeoAnalytics", "RasterAnalytics", "ImageHosting", "ImageServer", and "Server" nodes:

ParameterDescriptionRequired or optional
"KeypairName"

The Amazon Elastic Compute Cloud key pair to allow remote access to the EC2 instances.

Required if you did not specify this under the "Default" node.

"ELBDNSName"

Specify the DNS name of an existing Elastic Load Balancer (ELB). The ELB must be an application load balancer or classic load balancer.

If you do not want to use an ELB or want to configure it later, do not use this parameter.

Optional.

If you do specify this parameter, it must be specified under the specific server node—"GeoAnalytics", "RasterAnalytics", "ImageServer", "ImageHosting", "Server"—or under the "Default" node.

"InstanceType"

The Amazon Elastic Compute Cloud type to use for the ArcGIS GIS Server, ArcGIS GeoAnalytics Server, or ArcGIS Image Server machines.

Required if you did not specify this under the "Default" node.

"InstanceDriveSize"

The size (in GB) of the C: or root drive of the ArcGIS Server machines.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"ServerInstances"

The number of EC2 instances in the site.

The default number of instances is 2, the maximum is 10, and the minimum is 1.

Required if you did not specify this under the "Default" node.

"ServerLicenseFileKeyName"

The name of the ArcGIS GIS Server, ArcGIS GeoAnalytics Server, or ArcGIS Image Server object key name.

The .prvc or .epc file must be uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required if you did not specify this under the "Default" node.

"SiteadminUserName"

The user name of the ArcGIS Server primary site administrator.

Required if you did not specify this under the "Default" node.

"SiteadminUserPassword"

The password for the site administrator account.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Required if you did not specify this under the "Default" node.

"arcgisUserPassword"

The password for the account used to run the ArcGIS Server Windows service. The login name is always arcgis.

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

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

Conditional.

Applies if you deploy on Microsoft Windows instances (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows") and you did not specify this parameter under the "Default" node.

"ConfigStoreType"

The type of storage location for the ArcGIS Server site configuration store.

To use an EC2 machine, set this parameter to "FileSystem". To use an S3 bucket for the portal content directory and an S3 bucket and Amazon DynamoDB table for the portal content directory, set this parameter to "CloudStore".

Required if you did not specify this under the "Default" node.

"FileserverInstanceType"

The Amazon Elastic Compute Cloud instance type to use for the file server.

Required if you did not specify this under the "Default" node.

"FileserverInstanceDriveSize"

The size (in GB) of the C: or root drive of the ArcGIS Server file server machine.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"SiteDomain"

The domain name for your deployment.

If you use AWS Route 53 to manage your domain name servers (DNS) and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify a subdomain name. If you don't specify a subdomain name, a domain name based on the default naming convention will be used.

If you are not using AWS Route 53 to manage your domain name servers and didn't set the "AWSR53ZoneId" parameter, you must specify a fully qualified domain name for the "SiteDomain" parameter.

If you use your own DNS server to manage your domain name rather than using AWS Route 53, ensure the domain name ("SiteDomain") is mapped to the appropriate Elastic Load Balancer or Elastic IP address in your DNS before running ArcGIS Enterprise Cloud Builder CLI for AWS, so that the domain name is valid at the time of federation. You can create Elastic Load Balancers (using the AWS Management Console or Esri AWS CloudFormation templates) or Elastic IP addresses (using AWS Management Console).

Required if you did not specify this under the "Default" node.

"ServerWebadaptorName"

The web adaptor name for the ArcGIS Server site. Access to the ArcGIS Server site will be through a URL in the format https://<fully qualified domain name>/<web adaptor name>.

The default value depends on the node where this parameter is set. The following are the default web adaptor names for each node:

  • "gisserver" under the "Server" node
  • "geoanalytics" under the "GeoAnalytics" node
  • "rasteranalytics" under the "RasterAnalytics" node
  • "imageserver" under the "Image" node
  • "imagehosting" under the "ImageHosting" node

Optional.

If you do specify this parameter, it must be specified under the specific server node—"GeoAnalytics", "RasterAnalytics", "ImageServer", "ImageHosting", "Server". Do not specify this parameter under the "Default" node.

"SSLCertificateFileKeyName"

The SSL certificate file object key name. This must be a .pfx file you uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Optional.

If you do specify this parameter, it must be specified under the specific server node—"GeoAnalytics", "RasterAnalytics", "ImageServer", "ImageHosting", "Server"—or under the "Default" node.

"SSLCertificatePassword"

The password for the SSL certificate.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Conditional.

This parameter is mandatory only if you provide a value for the "SSLCertificateFileKeyName" parameter.

If applicable, you must specify this parameter under the specific server node—"GeoAnalytics", "RasterAnalytics", "ImageServer", "ImageHosting", "Server"—or under the "Default" node.

"CloudStoreS3BucketPath"

The bucket path in the format <bucket_name>/<folder_name>.

When used under the "RasterAnalytics" and "ImageHosting" nodes, the utility registers this location as the site's raster store. When used under other nodes, the utility registers the specified location as a cloud store. You must specify the location in the format indicated: <bucket_name>/<folder_name>. Be sure the S3 bucket exists and is accessible using the AWS credentials you provide under the "AWSCredentials" node. If the bucket does not exist, Cloud Builder will create a bucket with the default naming convention of <deployment_name>+rastore. If the <folder_name> you specify does not exist in the bucket, Cloud Builder creates it.

Required for the ArcGIS Image Server site you use as the portal's raster analysis or image hosting server.

This parameter is optional if you create a stand-alone or federated ArcGIS Image Server or ArcGIS GIS Server site.

Note:

If your deployment includes "RasterAnalytics" and "ImageHosting" nodes and you plan to use the same raster store for both, use the same value for the "CloudStoreS3BucketPath" parameter under these two nodes.

"Federate"

Specifies whether the site will be federated with a base ArcGIS Enterprise deployment (true) or a stand-alone site (false).

You must set "Federate" to true when creating an ArcGIS GeoAnalytics Server, raster analysis, or ArcGIS Image Server site.

If you don't specify this parameter in the deployment configuration file, the default value is false.

Required.

You must specify this parameter under the specific server node—"GeoAnalytics", "RasterAnalytics", "ImageServer", "ImageHosting", or "Server". Do not specify this parameter under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the specific server node—"GeoAnalytics", "RasterAnalytics", "ImageHosting", or "Server". Do not specify this parameter under the "Default" node.

Parameters for an ArcGIS GeoEvent Server site

Parameter values you specify under the "GeoEvent" node use the Esri ArcGIS GeoEvent Server CloudFormation template.

The following table lists all the possible parameters you can set under the "GeoEvent" node:

ParameterDescriptionRequired or optional
"KeypairName"

The Amazon Elastic Compute Cloud key pair to allow remote access to the EC2 instances.

Required if you did not specify this under the "Default" node.

"EIPAllocationID"

The allocation ID of the Elastic IP address of the VPC.

Optional.

If you do specify this parameter, it must be specified under the "GeoEvent" node or the "Default" node.

"InstanceType"

The Amazon Elastic Compute Cloud type to use for the ArcGIS GeoEvent Server machine.

Required if you did not specify this under the "Default" node.

"InstanceDriveSize"

The size (in GB) of the C: or root drive of the ArcGIS GeoEvent Server machine.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"ServerLicenseFileKeyName"

The name of the ArcGIS GeoEvent Server object key name.

The .prvc or .epc file must be uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required if you did not specify this under the "Default" node.

"SiteadminUserName"

The user name of the ArcGIS GeoEvent Server primary site administrator.

Required if you did not specify this under the "Default" node.

"SiteadminUserPassword"

The password for the site administrator account.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Required if you did not specify this under the "Default" node.

"arcgisUserPassword"

The password for the account used to run the ArcGIS GeoEvent Server Windows service. The login name is always arcgis.

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

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

Conditional.

Applies if you deploy on Microsoft Windows instances (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows") and you did not specify this parameter under the "Default" node.

"SiteDomain"

The domain name for your deployment.

If you use AWS Route 53 to manage your domain name servers (DNS) and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify a subdomain name. If you don't specify a subdomain name, a domain name based on the default naming convention will be used.

If you are not using AWS Route 53 to manage your domain name servers and didn't set the "AWSR53ZoneId" parameter, you must specify a fully qualified domain name for the "SiteDomain" parameter.

If you use your own DNS server to manage your domain name rather than using AWS Route 53, ensure the domain name ("SiteDomain") is mapped to the appropriate Elastic Load Balancer or Elastic IP address in your DNS before running ArcGIS Enterprise Cloud Builder CLI for AWS, so that the domain name is valid at the time of federation. You can create Elastic Load Balancers (using the AWS Management Console or Esri AWS CloudFormation templates) or Elastic IP addresses (using AWS Management Console).

Required if you did not specify this under the "Default" node.

"ServerWebadaptorName"

The web adaptor name for the ArcGIS GeoEvent Server site. Access to the ArcGIS GeoEvent Server site will be through a URL in the format https://<fully qualified domain name>/<web adaptor name>.

The default value is "geoevent".

Optional.

If you do specify this parameter, it must be specified under the "GeoEvent" node. Do not specify this parameter under the "Default" node.

"SSLCertificateFileKeyName"

The SSL certificate file object key name. This must be a .pfx file you uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required.

You must specify this parameter under the "GeoEvent" node or under the "Default" node.

"SSLCertificatePassword"

The password for the SSL certificate.

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

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

Required.

You must specify this parameter under the "GeoEvent" node or under the "Default" node.

"Federate"

Specifies whether the site will be federated with a base ArcGIS Enterprise deployment (true) or a stand-alone site (false).

If you don't specify this parameter in the deployment configuration file, the default value is false.

Required.

You must specify this parameter under the "GeoEvent" node. Do not specify this parameter under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the "GeoEvent" node. Do not specify this parameter under the "Default" node.

Parameters for an ArcGIS Notebook Server site

Parameter values you specify under the "NotebookServer" node use the Esri CloudFormation templates that launch an ArcGIS Notebook Server site. Note that ArcGIS Notebook Server sites must always be federated with an ArcGIS Enterprise portal, and you can create an ArcGIS Notebook Server site on the Ubuntu ArcGIS Notebook Server operating system only.

When you create a federated site, the ArcGIS Enterprise Cloud Builder CLI for AWS utility configures the site as your portal's Notebook Server; you do not need to configure this manually.

The following table lists all the possible parameters you can set under the "NotebookServer" node:

ParameterDescriptionRequired or optional
"KeypairName"

The Amazon Elastic Compute Cloud key pair to allow remote access to the EC2 instances.

Required if you did not specify this under the "Default" node.

"ELBDNSName"

Specify the DNS name of an existing Elastic Load Balancer (ELB). The ELB must be an application load balancer or classic load balancer.

If you do not want to use an ELB or want to configure it later, do not use this parameter.

Optional.

If you do specify this parameter, it must be specified under the "NotebookServer" node or under the "Default" node.

"InstanceType"

The Amazon Elastic Compute Cloud type to use for the ArcGIS Notebook Server machines.

Required if you did not specify this under the "Default" node.

"InstanceDriveSize"

The size (in GB) of the root drive of the ArcGIS Notebook Server machines.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"ServerInstances"

The number of EC2 instances in the site.

The default number of instances is 2, the maximum is 10, and the minimum is 1.

Required if you did not specify this under the "Default" node.

"ServerLicenseFileKeyName"

The name of the ArcGIS Notebook Server object key name.

The .prvc or .epc file must be uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required if you did not specify this under the "Default" node.

"LicenseLevel"

The ArcGIS Notebook Server license level. Available values are standard or advanced.

Required if you did not specify this under the "Default" node.

"SiteadminUserName"

The user name of the ArcGIS Notebook Server primary site administrator.

Required if you did not specify this under the "Default" node.

"SiteadminUserPassword"

The password for the site administrator account.

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

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

Required if you did not specify this under the "Default" node.

"FileserverInstanceType"

The Amazon Elastic Compute Cloud instance type to use for the file server.

Required if you did not specify this under the "Default" node.

"FileserverInstanceDriveSize"

The size (in GB) of the root drive of the ArcGIS Notebook Server file server machine.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"SiteDomain"

The domain name for your deployment.

If you use AWS Route 53 to manage your domain name servers (DNS) and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify a subdomain name. If you don't specify a subdomain name, a domain name based on the default naming convention will be used.

If you are not using AWS Route 53 to manage your domain name servers and didn't set the "AWSR53ZoneId" parameter, you must specify a fully qualified domain name for the "SiteDomain" parameter.

If you use your own DNS server to manage your domain name rather than using AWS Route 53, ensure the domain name ("SiteDomain") is mapped to the appropriate Elastic Load Balancer or Elastic IP address in your DNS before running ArcGIS Enterprise Cloud Builder CLI for AWS, so that the domain name is valid at the time of federation. You can create Elastic Load Balancers (using the AWS Management Console or Esri AWS CloudFormation templates) or Elastic IP addresses (using AWS Management Console).

Required if you did not specify this under the "Default" node.

"ServerWebadaptorName"

The web adaptor name for the ArcGIS Notebook Server site. Access to the ArcGIS Notebook Server site will be through a URL in the format https://<fully qualified domain name>/<web adaptor name>.

The default value is "notebook".

Optional.

If you do specify this parameter, it must be specified under the "NotebookServer" node. Do not specify this parameter under the "Default" node.

"SSLCertificateFileKeyName"

The SSL certificate file object key name. This must be a .pfx file you uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required.

You must specify this parameter under the "NotebookServer" node or under the "Default" node.

"SSLCertificatePassword"

The password for the SSL certificate.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Required.

You must specify this parameter under the "NotebookServer" node or under the "Default" node.

"Federate"

Specifies whether the site will be federated with a base ArcGIS Enterprise deployment (true) or a stand-alone site (false).

You must set "Federate" to true when creating an ArcGIS Notebook Server site.

If you don't specify this parameter in the deployment configuration file, the default value is false.

Required.

You must specify this parameter under the "NotebookServer" node. Do not specify this parameter under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the "NotebookServer" node. Do not specify this parameter under the "Default" node.

Parameters for an ArcGIS Mission Server site

Parameter values you specify under the "MissionServer" node use the Esri CloudFormation templates that launch an ArcGIS Mission Server site. Note that ArcGIS Mission Server sites must always be federated with an ArcGIS Enterprise portal.

When you create a federated ArcGIS Mission Server site, the ArcGIS Enterprise Cloud Builder CLI for AWS utility configures the site as your portal's Server; you do not need to configure this manually.

The following table lists all the possible parameters you can set under the "MissionServer" node:

ParameterDescriptionRequired or optional
"KeypairName"

The Amazon Elastic Compute Cloud key pair to allow remote access to the EC2 instances.

Required if you did not specify this under the "Default" node.

"ELBDNSName"

Specify the DNS name of an existing Elastic Load Balancer (ELB). The ELB must be an application load balancer or classic load balancer.

If you do not want to use an ELB or want to configure it later, do not use this parameter.

Optional.

If you do specify this parameter, it must be specified under the "MissionServer" node or under the "Default" node.

"InstanceType"

The Amazon Elastic Compute Cloud type to use for the ArcGIS Mission Server machines.

Required if you did not specify this under the "Default" node.

"InstanceDriveSize"

The size (in GB) of the C: or root drive of the ArcGIS Mission Server machines.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"ServerInstances"

The number of EC2 instances in the site.

The default number of instances is 2, the maximum is 10, and the minimum is 1.

Required if you did not specify this under the "Default" node.

"ServerLicenseFileKeyName"

The name of the ArcGIS Mission Server object key.

The .prvc or .epc file must be uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Required if you did not specify this under the "Default" node.

"SiteadminUserName"

The user name of the ArcGIS Mission Server primary site administrator.

Required if you did not specify this under the "Default" node.

"SiteadminUserPassword"

The password for the site administrator account.

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

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

Required if you did not specify this under the "Default" node.

"arcgisUserPassword"

The password for the account used to run the ArcGIS Mission Server Windows service. The login name is always arcgis.

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

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

Conditional.

Applies if you deploy on Microsoft Windows instances (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows") and you did not specify this parameter under the "Default" node.

"FileserverInstanceType"

The Amazon Elastic Compute Cloud instance type to use for the file server.

Required if you did not specify this under the "Default" node.

"FileserverInstanceDriveSize"

The size (in GB) of the C: or root drive of the ArcGIS Mission Server file server machine.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Required if you did not specify this under the "Default" node.

"SiteDomain"

The domain name for your deployment.

If you use AWS Route 53 to manage your domain name servers (DNS) and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify a subdomain name. If you don't specify a subdomain name, a domain name based on the default naming convention will be used.

If you are not using AWS Route 53 to manage your domain name servers and didn't set the "AWSR53ZoneId" parameter, you must specify a fully qualified domain name for the "SiteDomain" parameter.

If you use your own DNS server to manage your domain name rather than using AWS Route 53, ensure the domain name ("SiteDomain") is mapped to the appropriate Elastic Load Balancer or Elastic IP address in your DNS before running ArcGIS Enterprise Cloud Builder CLI for AWS, so that the domain name is valid at the time of federation. You can create Elastic Load Balancers (using the AWS Management Console or Esri AWS CloudFormation templates) or Elastic IP addresses (using AWS Management Console).

Required if you did not specify this under the "Default" node.

"ServerWebadaptorName"

The web adaptor name for the ArcGIS Mission Server site. Access to the ArcGIS Mission Server site will be through a URL in the format https://<fully qualified domain name>/<web adaptor name>.

The default value is "mission".

Optional.

If you do specify this parameter, it must be specified under the "MissionServer" node. Do not specify this parameter under the "Default" node.

"SSLCertificateFileKeyName"

The SSL certificate file object key name. This must be a .pfx file you uploaded to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.

Optional.

If you do specify this parameter, it must be specified under the "MissionServer" node or under the "Default" node.

"SSLCertificatePassword"

The password for the SSL certificate.

You can provide a plain text password or the Amazon Resource Name (ARN) of the secret ID from AWS Secrets Manager.

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

Conditional.

This parameter is mandatory only if you provide a value for the "SSLCertificateFileKeyName" parameter.

If applicable, you must specify this parameter under the "MissionServer" node or under the "Default" node.

"Federate"

Specifies whether the site will be federated with a base ArcGIS Enterprise deployment (true) or a stand-alone site (false).

You must set "Federate" to true when creating an ArcGIS Mission Server site.

If you don't specify this parameter in the deployment configuration file, the default value is false.

Required.

You must specify this parameter under the "MissionServer" node. Do not specify this parameter under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the "MissionServer" node. Do not specify this parameter under the "Default" node.

Parameters for spatiotemporal big data stores

Parameter values you specify under the "Spatiotemporal" node use the Esri CloudFormation template that launches an ArcGIS Data Store spatiotemporal big data store and registers it with the hosting server of an ArcGIS Enterprise portal.

When you create a spatiotemporal big data store, the ArcGIS Enterprise Cloud Builder CLI for AWS utility registers the data store for you; you do not need to add the spatiotemporal big data store to the hosting server manually.

Note:

The ArcGIS Enterprise Cloud Builder CLI for AWS utility uses some of the attributes from the "BaseEnterprise" node when configuring a spatiotemporal big data store to identify what deployment to register the data store with. Therefore, the JSON configuration file you use when configuring a spatiotemporal big data store must include the "BaseEnterprise" node and information and the "Spatiotemporal" node.

The following table lists all the possible parameters you can set under the "Spatiotemporal" node:

ParameterDescriptionRequired or optional
"KeypairName"

The Amazon Elastic Compute Cloud key pair to allow remote access to the EC2 instances.

Required if you did not specify this under the "Default" node.

"DatastoreInstances"

The number of Amazon Elastic Compute Cloud instances in the spatiotemporal big data store.

Available values are 1, 3, or 5. The default is 3.

Required if you did not specify this under the "Default" node.

"InstanceType"

The Amazon Elastic Compute Cloud type to use for the spatiotemporal big data store machines.

Required if you did not specify this under the "Default" node.

"InstanceDriveSize"

The size (in GB) of the C: or root drive of the spatiotemporal big data store machines.

The default size is 200 GB, the minimum size is 100 GB, and the maximum size is 4096 GB.

Required if you did not specify this under the "Default" node.

"arcgisUserPassword"

The password for the account used to run the ArcGIS Data Store Windows service. The login name is always arcgis.

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

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

Conditional.

Applies if you deploy on Microsoft Windows instances (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows") and you did not specify this parameter under the "Default" node.

"BackupLocationStorageType"

The type of storage used for spatiotemporal big data store backup files.

Available values are FileSystem or CloudStore.

If you specify FileSystem as the backup storage type, the utility creates an EC2 file server instance to store backup files.

If you specify as the backup storage type, spatiotemporal big data store backup files are stored in an Amazon S3 bucket created by the utility.

Required if you did not specify this under the "Default" node.

"FileserverInstanceType"

The Amazon Elastic Compute Cloud instance type to use for the file server.

Conditional.

This is required only if you set the "BackupLocationStorageType" parameter to "FileSystem" and you did not specify this under the "Default" node.

"FileserverInstanceDriveSize"

The size (in GB) of the C: or root drive of the file server machine.

The default size is 100 GB, the minimum size is 100 GB, and the maximum size is 1024 GB.

Conditional.

This is required only if you set the "BackupLocationStorageType" parameter to "FileSystem" and you did not specify this under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the "Spatiotemporal" node. Do not specify this parameter under the "Default" node.

Parameters for enterprise geodatabases in Amazon RDS for SQL Server

The parameter values that you specify under the "SQLEGDB" node use the Esri CloudFormation template that creates an enterprise geodatabase in Amazon RDS for SQL Server and registers it with an ArcGIS Server site.

The "SQLEGDB" node and parameters are only applicable if you deploy on Microsoft Windows instances (set the "OperatingSystem" parameter under the "DeploymentDetails" section of the JSON configuration document to "Windows").

Note:

The ArcGIS Enterprise Cloud Builder CLI for AWS utility uses attributes from the "Server" or "ImageServer" node to identify the ArcGIS Server site to register the geodatabase with. Therefore, the JSON configuration file you use when configuring an enterprise geodatabase must include the "Server" node or "ImageServer" node for the site to which you want to add an enterprise geodatabase.

The following table lists the possible parameters you can set under the "SQLEGDB" node:

ParameterDescriptionRequired or optional
"IsManaged"

Specify "false" to register the database with the ArcGIS Server site or specify "true" to configure the enterprise geodatabase as the managed database for the ArcGIS GIS Server site.

Managed databases are only supported for federated or stand-alone ArcGIS GIS Server sites and not for a hosting server or other server role.

The default value is "false".

Required if you did not specify this under the "Default" node.

"RDSInstanceClass"

The Amazon RDS EC2 instance class for the database where the enterprise geodatabase will be created.

Required if you did not specify this under the "Default" node.

"RDSAllocationStorage"

The allocated storage size of the Amazon RDS EC2 instance (in GB).

The default is 200 GB, the minimum is 200 GB, and the maximum is 4096 GB.

Required if you did not specify this under the "Default" node.

"SQLServerDBEngine"

The SQL Server database engine type. Available values are sqlserver-se or sqlserver-ee.

Required if you did not specify this under the "Default" node.

"SQLServerDBVersion"

The SQL Server database version.

Available values are as follows:

  • "15.00.4043.16.v1"
  • "14.00.3294.2.v1"
  • "14.00.3281.6.v1"
  • "14.00.3223.3.v1"
  • "14.00.3049.1.v1"
  • "14.00.3035.2.v1"
  • "14.00.3015.40.v1"
  • "14.00.1000.169.v1"
  • "13.00.5820.21.v1"
  • "13.00.5598.27.v1"
  • "13.00.5426.0.v1"
  • "13.00.5366.0.v1"
  • "13.00.5292.0.v1"
  • "13.00.5216.0.v1"
  • "13.00.4522.0.v1"
  • "13.00.4466.4.v1"
  • "13.00.4451.0.v1"
  • "13.00.4422.0.v1"
  • "13.00.2164.0.v1"

The default value is "15.00.4043.16.v1".

Required if you did not specify this under the "Default" node.

"RDSInstanceName"

The database identifier name.

The name must begin with a letter and contain only alphanumeric characters.

The minimum number of characters is 3 and the maximum is 63.

Required if you did not specify this under the "Default" node.

"RDSMasterUserName"

The RDS master user name.

The name must begin with a letter and contain only alphanumeric characters.

The minimum number of characters is 4 and the maximum is 16.

Required if you did not specify this under the "Default" node.

"RDSMasterUserPassword"

The password for the RDS master user.

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

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

Required if you did not specify this under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the "SQLEGDB" node. Do not specify this parameter under the "Default" node.

Parameters for enterprise geodatabases in Amazon RDS for PostgreSQL

The parameter values that you specify under the "PostgresEGDB" node use the Esri CloudFormation template that creates an enterprise geodatabase in Amazon RDS for PostgreSQL and registers it with an ArcGIS Server site.

Note:

The ArcGIS Enterprise Cloud Builder CLI for AWS utility uses attributes from the "Server" or "ImageServer" node to identify the ArcGIS Server site to register the geodatabase with. Therefore, the JSON configuration file you use when configuring an enterprise geodatabase must include the "Server" node or "ImageServer" node for the site to which you want to add an enterprise geodatabase.

The following table lists the possible parameters you can set under the "PostgresEGDB" node:

ParameterDescriptionRequired or optional
"IsManaged"

Specify "false" to register the database with the ArcGIS Server site or specify "true" to configure the enterprise geodatabase as the managed database for the ArcGIS GIS Server site.

Managed databases are only supported for federated or stand-alone ArcGIS GIS Server sites and not for a hosting server or other server role.

The default value is "false".

Required if you did not specify this under the "Default" node.

"RDSInstanceClass"

The Amazon RDS EC2 instance class for the database where the enterprise geodatabase will be created.

Required if you did not specify this under the "Default" node.

"RDSAllocationStorage"

The allocated storage size of the Amazon RDS EC2 instance (in GB).

The default is 200 GB, the minimum is 200 GB, and the maximum is 4096 GB.

Required if you did not specify this under the "Default" node.

"PostgresDBVersion"

The PostgreSQL database version.

Available values are as follows:

  • "12.4"
  • "11.9"
  • "10.14"

The default value is "12.4".

Required if you did not specify this under the "Default" node.

"RDSInstanceName"

The database identifier name.

The name must begin with a letter and contain only alphanumeric characters.

The minimum number of characters is 3 and the maximum is 63.

Required if you did not specify this under the "Default" node.

"RDSMasterUserName"

The RDS master user name.

The name must begin with a letter and contain only alphanumeric characters.

The minimum number of characters is 4 and the maximum is 16.

Required if you did not specify this under the "Default" node.

"RDSMasterUserPassword"

The password for the RDS master user.

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

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

Required if you did not specify this under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the "PostgresEGDB" node. Do not specify this parameter under the "Default" node.

Parameters for enterprise geodatabases in Aurora PostgreSQL

The parameter values that you specify under the "AuroraEGDB" node use the Esri CloudFormation template that creates an enterprise geodatabase in Aurora PostgreSQL and registers it with an ArcGIS Server site.

Note:

The ArcGIS Enterprise Cloud Builder CLI for AWS utility uses attributes from the "Server" or "ImageServer" node to identify the ArcGIS Server site to register the geodatabase with. Therefore, the JSON configuration file you use when configuring an enterprise geodatabase must include the "Server" node or "ImageServer" node for the site to which you want to add an enterprise geodatabase.

The following table lists the possible parameters you can set under the "AuroraEGDB" node:

ParameterDescriptionRequired or optional
"IsManaged"

Specify "false" to register the database with the ArcGIS Server site or specify "true" to configure the enterprise geodatabase as the managed database for the ArcGIS GIS Server site.

Managed databases are only supported for federated or stand-alone ArcGIS GIS Server sites and not for a hosting server or other server role.

The default value is "false".

Required if you did not specify this under the "Default" node.

"RDSInstanceClass"

The Amazon RDS EC2 instance class for the database where the enterprise geodatabase will be created.

Required if you did not specify this under the "Default" node.

"PostgresDBVersion"

The PostgreSQL database version.

Available values are as follows:

  • "11.8"
  • "10.13"

The default value is "11.8".

Required if you did not specify this under the "Default" node.

"RDSInstanceName"

The database identifier name.

The name must begin with a letter and contain only alphanumeric characters.

The minimum number of characters is 3 and the maximum is 63.

Required if you did not specify this under the "Default" node.

"RDSMasterUserName"

The RDS master user name.

The name must begin with a letter and contain only alphanumeric characters.

The minimum number of characters is 4 and the maximum is 16.

Required if you did not specify this under the "Default" node.

"RDSMasterUserPassword"

The password for the RDS master user.

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

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

Required if you did not specify this under the "Default" node.

"TemplateURL"

If you want to use your own CloudFormation template for this deployment instead of the templates provided by Esri, you can define your template. Provide a valid HTTPS URL.

Optional.

If you specify this parameter, you must specify it under the "AuroraEGDB" node. Do not specify this parameter under the "Default" node.

DNS parameters

If you use AWS Route 53 to manage your DNS, you must define an AWS Route 53 zone ID under the "DNSParameters" node. When you run the ArcGIS Enterprise Cloud Builder CLI for AWS utility, it updates the DNS to map each domain name ("SiteDomain") to the appropriate Elastic Load Balancer or Elastic IP address.

The parameter is required if you use AWS Route 53. If you do not use AWS Route 53, you can leave this parameter blank.

In this example, AWS Route 53 zone ZUJQ3S2DAL123 will be mapped to the Elastic IP address you specified for the base deployment "SiteDomain" parameter.

"DNSParameters":{       
    "AWSR53ZoneId": "ZUJQ3S2DAL123"  
}