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 file	Description
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 file	Description
baseenterpriseallinone.json	Deploys base ArcGIS Enterprise on a single machine.
baseenterpriseha.json	Deploys base ArcGIS Enterprise on two machines: a primary and a standby machine.
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.
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.
baseenterpriseimagehosting.json	Deploys base ArcGIS Enterprise plus a federated ArcGIS Image Server site configured as the portal's image hosting server.
baseenterpriseimagehostingrasterstore.json	Deploys base ArcGIS Enterprise plus a federated ArcGIS Image Server sites configured as the portal's image hosting server. You can optionally use this file to create a cloud store in S3 and register it as a raster store.
standalonegeoevent.json	Deploys a stand-alone ArcGIS GeoEvent Server site.
standaloneserver.json	Deploys a stand-alone ArcGIS GIS Server site.
standaloneimageserver.json	Deploys a stand-alone ArcGIS Image Server site.
standaloneserverwithexistingelb.json	Deploys a stand-alone ArcGIS GIS Server site using an Elastic Load Balancer you already created.
completeArcGISenterprise.json	Allows you to deploy an all-in-one or highly available base ArcGIS Enterprise and all possible federated ArcGIS Server sites.

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.

Parameter	Description	Required 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:

Parameter	Description	Required 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:

Parameter	Description	Required 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.
"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 newer 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.

"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>",
       "OperatingSystem": "<Windows | Ubuntu>" 
   }

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

In this example, the names of all machines in the deployment will start with testservers. The 10.8 Esri Ubuntu Amazon Machine Images (AMIs) will be used for the deployment.

"DeploymentDetails": {
       "DeploymentName": "testservers",
       "ArcGISVersion": "10.8",
       "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.

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 "ServerLicenseFile" 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:

Parameter	Description	Required 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 "SSLCertificateFile" and "SSLCertPassword" 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 ("DriveSizeRoot"), S3 bucket, administrator user name and password, and the password for the software services ("RunAsUserPassword") 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",   
        "DriveSizeRoot": "300",
        "KeyName": "StackTest_Mine",      
        "DBEngine": "none",
        "DBInstanceClass": "db.m4.large",
        "DBAllocatedStorage": "200",
        "SiteAdmin": "admin",
        "SiteAdminPassword": "changeit",    
        "RunAsUserPassword": "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 this 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:

Parameter	Description	Required or optional
"DriveSizeRoot"	The size (in GB) of the C: or root drive of the ArcGIS Enterprise machines.	Required if you did not specify this under the "Default" node.
"InstanceType"	The Amazon Elastic Compute Cloud instance type to use for the ArcGIS Enterprise machine.	Required if you deploy the base ArcGIS Enterprise on a single machine. (Set the "Type" parameter to "AllInOne".)
"FSInstanceType"	The Amazon Elastic Compute Cloud instance type to use for the file server.	Required if you create a highly available ArcGIS Enterprise deployment. (Set the "Type" parameter to "HA".)
"ASInstanceType"	The Amazon Elastic Compute Cloud instance type to use for the hosting server.	Required if you create a highly available ArcGIS Enterprise deployment. (Set the "Type" parameter to "HA".)
"BDSInstanceType"	The Amazon Elastic Compute Cloud instance type to use for spatiotemporal big data store machines.	Required if you did not specify this under the "Default" node. Even if you do not initially deploy a spatiotemporal big data store, you must specify an instance type so that autoscaling is configured in the stack.
"BDSInstances"	The number of EC2 instances to create for a spatiotemporal big data store. You can specify "0" if you do not want to include a spatiotemporal big data store in the deployment at this time. Otherwise, specify the number of instances you want.	Required if you did not specify this under the "Default" node.
"KeyName"	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.
"StoreType"	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.
"ServerLicenseFile"	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.
"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.	Specify an appropriate user ID. Ensure this user ID exists in the Portal for ArcGIS license file.
"PortalLicenseFile"	The name of the Portal for ArcGIS license file. 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.
"SiteAdmin"	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.
"SiteAdminPassword"	The password for the site administrator account.	Required if you did not specify this under the "Default" node.
"SiteEIPAllocationID"	The allocation ID of the Elastic IP address of the VPC you specified under the "Default" CloudFormation parameters.	Required if you deploy the base ArcGIS Enterprise on a single machine. (Set the "Type" parameter to "AllInOne".)
"RunAsUserPassword"	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.	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.
"SSLCertificateFile"	The SSL certificate file issued to the site domain. This must be a .pfx file you 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.
"SSLCertPassword"	The password for the SSL certificate.	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 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.
"PostInstallationScript"	The name of a zip archive file that contains a custom postinstallation script, or, if you do not have a custom script, set this parameter to "NONE". If using a custom postinstallation script, you must upload the zip file to the deployment Amazon S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.	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, but if you do specify this parameter, it must be specified under the "BaseEnterprise" node, not the "Default" node.
"Type"	Possible values are "AllInOne" to deploy all parts of the deployment on a single machine or "HA" to create highly available deployment.	Required. This parameter must be specified under the "BaseEnterprise" node, not the "Default" node.
"ELBName"	Specify the name of an existing Elastic Load Balancer that was created using the Esri AWS CloudFormation templates, or set this parameter to "NEW_ELB" to create and use a new one. When you set "ELBName" to "NEW_ELB", AWS assigns a name to the load balancer it creates. You must type "NEW_ELB" as shown, in all capital letters.	Required if you create a highly available ArcGIS Enterprise deployment (set the "Type" parameter to "HA").

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 a 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.

Parameter	Description	Required or optional
"ServerLicenseFile"	The .prvc or .epc file to license your ArcGIS GeoAnalytics Server, ArcGIS Image Server, or ArcGIS GIS Server site.	Required.
"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 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 your 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.
"DriveSizeRoot"	The size (in GB) of the C: or root drive of the ArcGIS GeoAnalytics Server, ArcGIS Image Server, or ArcGIS GIS Server machines.	Required if you did not specify this under the "Default" node.
"FSInstanceType"	The Amazon Elastic Compute Cloud instance type to use for the file server.	Required if you did not specify this under the "Default" node.
"ASInstanceType"	The Amazon Elastic Compute Cloud instance type to use for the ArcGIS GeoAnalytics Server, ArcGIS Image Server, or ArcGIS GIS Server machines.	Required if you did not specify this under the "Default" node.
"ASInstances"	The number of Amazon Elastic Compute Cloud instances launched by AutoScaling. This number should equal the total number of machines composing an ArcGIS Server site.	Required if you did not specify this under the "Default" node.
"KeyName"	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.
"StoreType"	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.
"SiteAdmin"	The user name of the ArcGIS Server primary site administrator.	Required if you did not specify this under the "Default" node.
"SiteAdminPassword"	The password for the site administrator account.	Required if you did not specify this under the "Default" node.
"RunAsUserPassword"	The password for the account used to run the ArcGIS Server Windows service. The login name is always ArcGIS.	Required if you deploy on Windows machines (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows"), and you didn't specify this parameter under the "Default" node.
"ELBName"	Specify the name of an existing Elastic Load Balancer that was created using the Esri AWS CloudFormation templates, or set this parameter to "NEW_ELB" to create and use a new one. When you set "ELBName" to "NEW_ELB", AWS assigns a name to the load balancer it creates. You must type "NEW_ELB" as shown, in all capital letters.	Required if you did not specify this under the "Default" node.
"SSLCertificateARN"	Amazon Resource Name (ARN) of the SSL certificate issued to the site domain.	Required only if you do not use an existing Elastic Load Balancer.
"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.	Required if you use your own DNS server to manage your domain name rather than using AWS Route 53.
"DBEngine"	If you deploy Windows Amazon Elastic Compute Cloud instances, you can set this parameter to one of the following: "none"—No Amazon relational database service instance is created. "sqlserver-se"—Creates an Amazon RDS for SQL Server instance and registers it with your site. "postgres"—Creates an Amazon RDS for PostgreSQL instance and registers it with your site. "aurora-postgresql"—Creates an Amazon Aurora PostgreSQL instance and registers it with your site. If you deploy Ubuntu Amazon Elastic Compute Cloud instances, you can set this parameter to "none", "aurora-postgresql", or "postgres".	Required if you did not specify this under the "Default" node.
"DBInstanceClass"	The instance class for an Amazon relational database service instance.	Required if you did not specify this parameter under the "Default" node and you set "DBEngine" to "sqlserver-se", "postgres", or "aurora-postgresql".
"DBAllocatedStorage"	The allocated storage size (in GB) of an Amazon relational database service instance.	Required if you did not specify this parameter under the "Default" node and you set "DBEngine" to "sqlserver-se" or "postgres".
"PostInstallationScript"	The name of a zip archive file that contains a custom postinstallation script or, if you do not have a custom script, set this parameter to "NONE". If using a custom postinstallation script, you must upload the zip file to the deployment Amazon S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.	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 specific server node—"GeoAnalytics", "RasterAnalytics", "ImageHosting", or "Server"—not under the "Default" node.

Parameters for 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.

Parameter	Description	Required or optional
"ServerLicenseFile"	The .prvc or .ecp file to license your ArcGIS GeoEvent Server site.	Required
"Federate"	Specifies whether the site will be federated with your 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 if you did not specify this under the "Default" node.
"DriveSizeRoot"	The size (in GB) of the C: or root drive of the ArcGIS GeoEvent Server machines.	Required if you did not specify this under the "Default" node.
"ASInstanceType"	The Amazon Elastic Compute Cloud instance type to use for the ArcGIS GeoEvent Server machines.	Required if you did not specify this under the "Default" node.
"FSInstanceType"	The Amazon Elastic Compute Cloud instance type to use for the file server.	Required if you did not specify this under the "Default" node.
"ELBName"	Specify the name of an existing Elastic Load Balancer that was created using the Esri AWS CloudFormation template, or set this parameter to "NEW_ELB" to create and use a new Elastic Load Balancer. When you set "ELBName" to "NEW_ELB", AWS assigns a name to the load balancer it creates. You must type "NEW_ELB" as shown, in all capital letters.	Required if you did not specify this under the "Default" node.
"KeyName"	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.
"SiteAdmin"	The user name of the ArcGIS Server primary site administrator.	Required if you did not specify this under the "Default" node.
"SiteAdminPassword"	The password for the site administrator account.	Required if you did not specify this under the "Default" node.
"RunAsUserPassword"	The password for the account used to run the ArcGIS Server Windows service. The login name is always ArcGIS.	Required if you deploy on Windows machines (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows") and you didn't specify this parameter under the "Default" node.
"SSLCertificateFile"	The SSL certificate file issued to the site domain. This must be a .pfx file you uploaded to the S3 bucket you specified for the "DeploymentBucket".	Required if you did not specify this under the "Default" node.
"SSLCertPassword"	The password for the SSL certificate.	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.	Required if you use your own DNS server to manage your domain name rather than using AWS Route 53.
"PostInstallationScript"	The name of a zip archive file that contains a custom postinstallation script, or, if you do not have a custom script, set this parameter to "NONE". If using a custom postinstallation script, you must upload the zip file to the deployment S3 bucket managed by ArcGIS Enterprise Cloud Builder for AWS.	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. This parameter must be specified under the "GeoEvent" node, not 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 operating system only.

When you create a federated ArcGIS Notebook Server 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.

Parameter	Description	Required or optional
"ServerLicenseFile"	The .prvc or .ecp file to license your ArcGIS Notebook Server site.	Required.
"Federate"	Specifies whether the site will be federated with your 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.
"DriveSizeRoot"	The size (in GB) of the C: or root drive of the ArcGIS Notebook Server machines.	Required if you did not specify this under the "Default" node.
"InstanceType"	The Amazon Elastic Compute Cloud instance type to use for the ArcGIS Notebook Server machines.	Required if you did not specify this under the "Default" node.
"KeyName"	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.
"SiteAdmin"	The user name of the ArcGIS Server primary site administrator.	Required if you did not specify this under the "Default" node.
"SiteAdminPassword"	The password for the site administrator account.	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.	Required if you use your own DNS server to manage your domain name rather than using AWS Route 53.
"SSLCertificateFile"	The SSL certificate file issued to the site domain. This must be a .pfx file you uploaded to the S3 bucket you specified for the managed by ArcGIS Enterprise Cloud Builder for AWS.	Required if you did not specify this under the "Default" node.
"SSLCertPassword"	The password for the SSL certificate.	Required if you did not specify this under the "Default" node.
"SiteEIPAllocationID"	The allocation ID of the Elastic IP address of the VPC you specified under the "NotebookServer" CloudFormation parameters.	Required and must be under the "NotebookServer" node.
"AdditionalInstances"	The additional number of machines required in an ArcGIS Notebook Server site. The default value is zero (0). If you specify 0, the ArcGIS Notebook Server site will contain only one machine.	Required and must be under the "NotebookServer" node.
"BaseAMI"	The Amazon Machine Image ID used to create the ArcGIS Notebook Server site.	Optional.
"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. This parameter must be specified under the "NotebookServer" node, not 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.

Parameter	Description	Required or optional
"ServerLicenseFile"	The .prvc or .ecp file to license your ArcGIS Mission Server site.	Required.
"Federate"	Specifies whether the site will be federated with your 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.
"DriveSizeRoot"	The size (in GB) of the C: or root drive of the ArcGIS Mission Server machine.	Required if you did not specify this under the "Default" node.
"InstanceType"	The Amazon Elastic Compute Cloud instance type to use for the ArcGIS Notebook Server machines.	Required if you did not specify this under the "Default" node.
"KeyName"	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.
"SiteAdmin"	The user name of the ArcGIS Server primary site administrator.	Required if you did not specify this under the "Default" node.
"SiteAdminPassword"	The password for the site administrator account.	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.	Required if you use your own DNS server to manage your domain name rather than using AWS Route 53.
"SSLCertificateFile"	The SSL certificate file issued to the site domain. This must be a .pfx file you uploaded to the S3 bucket you specified for the managed by ArcGIS Enterprise Cloud Builder for AWS.	Required if you did not specify this under the "Default" node.
"SSLCertPassword"	The password for the SSL certificate.	Required if you did not specify this under the "Default" node.
"SiteEIPAllocationID"	The allocation ID of the Elastic IP address of the VPC you specified under the "MissionServer" CloudFormation parameters.	Required and must be under the "MissionServer" node.
"RunAsUserPassword"	The password for the account used to run the ArcGIS Server Windows service. The login name is always ArcGIS.	Required if you deploy on Windows machines (set the "OperatingSystem" parameter under the "DeploymentDetails" to "Windows"), and you didn't specify this parameter under the "Default" node.
"BaseAMI"	The Amazon Machine Image ID used to create the ArcGIS Mission Server site.	Optional.
"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. This parameter must be specified under the "MissionServer" node, not under the "Default" node.

DNS parameters

If you use AWS Route 53 to manage your domain name servers (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 (ELB) or Elastic IP address (EIP).

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"  
}