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.

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 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 a Virtual Private Cloud (VPC) in the AWS region you specify.

uploadlicensefile.json

Uploads ArcGIS Server licenses and a Portal for ArcGIS license. If you want to specify a name for the Amazon Simple Storage Service (S3) bucket, add the "DeploymentBucket" parameter under the "ArcGISEnterpriseFiles" section; otherwise, a bucket with a default name is created.

uploadsslcert.json

Uploads an SSL certificate to the Amazon S3 bucket you specify 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 you specify. It also imports the SSL certificate to AWS Certificate Manager.

allprep.json

Creates a VPC and uploads ArcGIS Server licenses, a Portal for ArcGIS license, and an SSL certificate to the Amazon S3 bucket you specify. It also imports the SSL certificate to AWS Certificate Manager.

Creation sample fileDescription
baseenterpriseallinone.json

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

baseenterpriseallinonewithga.json

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

standalonegeoevent.json

Deploys a stand-alone ArcGIS GeoEvent Server site.

standaloneserver.json

Deploys a stand-alone ArcGIS GIS Server site.

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.

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 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 and upload your SSL certificate and ArcGIS software licenses to the S3 bucket. You can 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 (true) a VPC or not (false).

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

ArcGIS Enterprise files

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

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

"ArcGISEnterpriseFiles": {
	 "DeploymentBucket": "clitesting",
		"PortalLicense": "E:\\AWS\\Testing\\Version10.6\\portal_2000_1000.prvc",
		"ServerLicense": "E:\\AWS\\Testing\\Version10.6\\Server_Ent_Adv_AllExt.prvc",
		"GeoAnalyticsLicense": "E:\\AWS\\Testing\\Version10.6\\Server_GeoAnalytics.prvc",
		"RasterAnalyticsLicense": "E:\\AWS\\Testing\\Version10.6\\Server_Image.prvc",
		"GeoEventLicense": "E:\\AWS\\Testing\\Version10.6\\Server_GeoEvent.prvc",
		"SSLCertificateFile": "E:\\AWS\\Testing\\wildcard_webgistesting_net.pfx",
		"SSLCertPassword": "abc123"
	}

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

ParameterDescriptionRequired or optional?
"DeploymentBucket"

The name of an Amazon S3 bucket in which to store ArcGIS license files (.prvc or .epc) and SSL certificates (.pfx) files.

The tool checks if an S3 bucket with the specified name already exists in this AWS region. If it does not exist, the utility creates a bucket in the region you specified under the "AWSCredentials". node.

Optional; if not specified, an Amazon S3 bucket is created for you.

"PortalLicense"

Your Portal for ArcGIS license file (.prvc or .epc).

Specify the physical path to the license file on local disk so the utility can upload it to the S3 bucket.

Required if you deploy ArcGIS Enterprise.

"ServerLicense"

Your ArcGIS GIS Server license file (.prvc or .epc)

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

"GeoAnalyticsLicense"

Your ArcGIS GeoAnalytics Server license file (.prvc or .epc)

Required if you deploy an ArcGIS GeoAnalytics Server.

"RasterAnalyticsLicense"

Your ArcGIS Image Server license file (.prvc or .epc)

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

"GeoEventLicense"

Your ArcGIS GeoEvent Server license file (.prvc or .epc)

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 S3 bucket.

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 Cloud Compute (EC2) instances (machines) in your deployment, the ArcGIS software version you want to deploy (10.5 or newer release), and which operating system (either Windows or Ubuntu) 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>",
       "OperatingSystem": "<Windows | Ubuntu>" 
   }

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

In this example, the names of all machines in the deployment will start with testservers. The 10.6 Esri Ubuntu AMIs will be used for the deployment.

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

CloudFormation parameters

The parameters required by the CloudFormation templates are organised 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.
  • "RasterAnalytics"—Parameters set in this section apply only to federated or stand-alone ArcGIS Image Server sites.
  • "Server"—Parameters set in this section apply only to federated or stand-alone ArcGIS GIS 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:

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, specify the "DeploymentBucket" parameter under the "Default" node, as all the machines will use the same bucket. Similarly, if you have a wildcard SSL certificate, specify the "SSLCertificateFile" and "SSLCertPassword" parameters under the "Default" node for sites to use.

As shown in the following example, the "VPCId", "Subnet1", and "Subnet2" parameters are used to define the VPC. The root and data drive sizes ("DriveSizeRoot" and "DriveSizeData"), 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",
        "DriveSizeData": "400",
        "KeyName": "StackTest_Mine",      
        "DBEngine": "none",
        "DBInstanceClass": "db.m4.large",
        "DBAllocatedStorage": "200",
        "DeploymentBucket": "mydeployments",
        "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 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:

ParameterDescriptionRequired or optional?
"DeploymentBucket"

The name of the Amazon S3 bucket in which you placed your ArcGIS license files and SSL certificates (.pfx) files.

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 Enterprise machines.

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

"DriveSizeData"

The size (in GB) of the D: or data drive of the ArcGIS Enterprise machines.

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

"InstanceType"

The Amazon EC2 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 EC2 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 EC2 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 EC2 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 EC2 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 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 S3 bucket you specified for the "DeploymentBucket".

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

"PortalLicenseFile"

The name of the Portal for ArcGIS license file. This file must be uploaded to the S3 bucket you specified for the "DeploymentBucket".

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 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 and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify subdomain name. If you don't specify a subdomain name, then domain name based on 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 Amazon S3 bucket you specified for the "DeploymentBucket".

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

"Type"

Possible values are "AllInOne" to deploy all parts of the deployment on a single machine or "HA" to create highly available deployment.

Required

"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

Parameter values you specify under the "GeoAnalytics", "RasterAnalytics", 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, the site must be federated with a portal.

When you create a federated ArcGIS GeoAnalytics Server or ArcGIS Image Server site, the ArcGIS Enterprise Cloud Builder CLI for AWS utility configures these sites as your portal's GeoAnalytics and raster analysis 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", and "Server" nodes.

ParameterDescriptionRequired or optional?
"ServerLicenseFile"

The .prvc or .epc file to license your ArcGIS GeoAnalytics Server, ArcGIS Image Server, or ArcGIS GIS Server site.

Required

"ClouStoreS3BucketPath"

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

When used under the "RasterAnalytics" node, 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 <folder_name> you specify does not exist in the bucket, the utility 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 ArcGIS Image Server site, stand-alone ArcGIS GIS Server site, or federated ArcGIS GIS Server site.

"Federate"

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

You must set "Federate" to true when creating a ArcGIS GeoAnalytics Server site.

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

Required

"DeploymentBucket"

The name of the S3 bucket in which you place your ArcGIS license files and SSL certificates (.pfx) files.

Required if you didn't specify this under the "Default" node.

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

"DriveSizeData"

The size (in GB) of the D: or data 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 EC2 instance type to use for the file server.

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

"ASInstanceType"

The Amazon EC2 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.

"SecondaryInstances"

The number of secondary Amazon EC2 instances launched by AutoScaling.

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

"KeyName"

The Amazon EC2 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.

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 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 and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify subdomain name. If you don't specify a subdomain name, then domain name based on default naming convention will be used.

Required if you didn't specify this under the "Default" node.

"DBEngine"

If you deploy Windows Amazon EC2 instances, you can set this parameter to one of the following: if you do not want to , to create and register an Amazon RDS for SQL Server instance with your site. or

  • "none"—No Amazon RDS 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.

If you deploy Ubuntu Amazon EC2 instances, you can set this parameter to "none" or "postgres".

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

"DBInstanceClass"

The instance class for an Amazon RDS instance.

Required if you did not specify this parameter under the "Default" node and you set "DBEngine" to "sqlserver-se" or "postgres".

"DBAllocatedStorage"

The allocated storage size (in GB) of an Amazon RDS 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 Amazon S3 bucket you specified for the "DeploymentBucket".

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

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.

ParameterDescriptionRequired or optional?
"ServerLicenseFile"

The .prvc or .ecp file to license your ArcGIS GeoEvent Server site.

Required

"Federate"

Specifies whether the site will be federated (true) with your base ArcGIS Enterprise deployment 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.

"DeploymentBucket"

The name of the S3 bucket in which you place your ArcGIS license files and SSL certificates (.pfx) files.

Required if you didn't 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.

"DriveSizeData"

The size (in GB) of the D: or data drive of the ArcGIS GeoEvent Server machines.

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

"ASInstanceType"

The Amazon EC2 instance type to use for the ArcGIS GeoEvent Server machines.

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

"KeyName"

The Amazon EC2 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.

"SiteEIPAllocationID

The allocation ID of the Elastic IP address for your VPC in the format eipalloc-<uniqueID>.

Required

"SSLCertificateFile"

The SSL certificate file issued to the site domain. This must 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 and, therefore, have set the "AWSR53ZoneId" parameter under the DNS parameter settings, you can specify subdomain name. If you don't specify a subdomain name, then domain name based on 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 domain names rather than using AWS Route 53, be sure the domain name you specify for "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. This ensures the domain name is valid when the ArcGIS GeoAnalytics Server site is federated with the portal. You can create Elastic Load Balancers using the AWS Management Console or Esri sample AWS CloudFormation templates. You can create Elastic IP addresses using AWS Management Console.

Required if you didn't 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 S3 bucket you specified for the "DeploymentBucket".

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

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