Skip To Content

ArcGIS Enterprise Cloud Builder CLI for AWS 参数

使用 ArcGIS Enterprise Cloud Builder Command Line Interface for Amazon Web Services (AWS) 准备和部署 ArcGIS EnterpriseArcGIS Server 站点时,可通过提供包含所需设置的 JSON 文件的位置和名称,提供有关所需部署类型的信息。

示例文件

My Esri 下载的 ArcGIS Enterprise Cloud Builder CLI for AWS 文件中包含多个示例 JSON 文件。JSON 示例代表常见的部署。有用于准备步骤的单独文件,使用 PREP 命令运行 ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序时可以使用这些文件,以及使用 CREATE 命令运行 ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序时可用于创建部署的文件。

以下两个表格介绍了 ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序随附的示例文件:

准备示例文件说明
createnetworkvpc.json

在指定的 AWS 区域中创建 Amazon Virtual Private Cloud (VPC)

uploadlicensefile.json

ArcGIS Server 许可和 Portal for ArcGIS 许可文件上传到 ArcGIS Enterprise Cloud Builder for Amazon Web Services 托管的 Amazon Simple Storage Service (S3) 存储段。

uploadsslcert.json

将 SSL 证书上传到 Cloud Builder 托管的 Amazon S3 存储段,然后将 SSL 证书导入到 AWS 证书管理器。

uploadlicenseandcert.json

ArcGIS Server 许可、Portal for ArcGIS 许可和 SSL 证书上传到 Cloud Builder 托管的 Amazon S3 存储段。此举还会将 SSL 证书导入到 AWS 证书管理器。

allprep.json

创建 VPC,然后将 ArcGIS Server 许可、Portal for ArcGIS JSON 文件和 SSL 证书上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的 Amazon S3 存储段。此举还会将 SSL 证书导入到 AWS 证书管理器。

创建示例文件说明
baseenterpriseallinone.json

在一台计算机上部署基础 ArcGIS Enterprise

baseenterpriseha.json

在两台计算机上部署基础 ArcGIS Enterprise:一台主计算机和一台备用计算机。

baseenterpriseallinonewithra.json

部署基础 ArcGIS Enterprise 以及配置为门户的栅格分析服务器的联合 ArcGIS Image Server 站点。

baseenterprisehawithga.json

在两台计算机上部署基础 ArcGIS Enterprise 以及配置为门户的 GeoAnalytics 服务器的联合 ArcGIS GeoAnalytics Server 站点。

baseenterprisehawithnotebook.json

在两台计算机和联合 ArcGIS Notebook Server 上部署基础 ArcGIS Enterprise

baseenterprisewithmission.json

在一台计算机和一台联合 ArcGIS Mission Server 上部署基础 ArcGIS Enterprise

baseenterpriseimagehosting.json

部署基础 ArcGIS Enterprise 以及配置为门户的影像托管服务器的联合 ArcGIS Image Server 站点。

baseenterpriseimagehostingrasterstore.json

部署基础 ArcGIS Enterprise 以及配置为门户的影像托管服务器的联合 ArcGIS Image Server 站点。您可以选择使用此文件在 S3 中创建云存储并将其注册为栅格存储。

standalonegeoevent.json

部署独立 ArcGIS GeoEvent Server 站点。

standaloneserver.json

部署独立 ArcGIS GIS Server 站点。

standaloneimageserver.json

部署独立 ArcGIS Image Server 站点。

standaloneserverwithexistingelb.json

可以使用已创建的弹性负载均衡器来部署独立 ArcGIS GIS Server 站点。

completeArcGISenterprise.json

用于部署一体化或高可用性基础 ArcGIS Enterprise 和所有可能的联合 ArcGIS Server 站点。

您可以使用文本编辑器复制和更改这些文件,也可以创建自己的 JSON 文件。使用示例时,需要将示例设置替换为部署特定值。还可以更改显示在示例文件中的参数。

JSON 文件中的参数一起分组在部分(节点)标题下。本主题的其余部分将介绍这些参数及其分组。

AWS 凭据和区域

要连接到 Amazon Web Services,命令需要 AWS 凭据。凭据可以是 AWS 帐户的访问密钥和保密密钥,也可以是帐户的 AWS 配置文件名称。运行 ArcGIS Enterprise Cloud Builder CLI for AWS实用程序时需要这些凭据,它们一起分组在 "AWSCredentials" 部分下。

您还需要指定要在其中进行部署的 AWS 区域。对于部署的所有组件,此区域必须相同。

参数说明必选或可选
"AWSAccessKey"

AWS 帐户的访问密钥。

如果未指定 "AWSProfileName" 参数,则为必填参数。

"AWSSecretKey"

AWS 帐户的保密密钥。

如果未指定 "AWSProfileName" 参数,则为必填参数。

"AWSProfileName"

AWS 帐户配置的配置文件名称。

如果未指定 "AWSAccessKey""AWSSecretKey" 参数,则为必填参数。

"AWSRegion"

将在其中创建部署的所有部分的 AWS 区域。

必填项。

在此示例中,授权凭证为 AWS 帐户的访问密钥和保密密钥。将在 AWS 区域 eu-west-2 中启动 Amazon Elastic Compute Cloud (EC2) 实例。

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

在此示例中,身份验证凭据指为 AWS 帐户配置的配置文件名称。将在 AWS 区域 us-west-1 中启动 EC2 实例。

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

要在用于部署准备的文件中使用的参数

创建部署之前,必须创建 ArcGIS Enterprise Cloud Builder for AWS 托管的 VPCS3 部署存储段,然后将 SSL 证书和 ArcGIS 软件许可上传到 S3 存储段。可在准备 .json 文件中设置参数来完成这些步骤。

网络堆栈

"NetworkStack" 部分是准备文件的可选部分,用于创建 VPC

在此示例中,实用程序将在 AWS 区域 eu-west-2b 和 eu-west-2a 中创建 VPC,然后为其分配名称标签 MyEnterpriseVPC

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

下表介绍了可在 "NetworkStack" 部分中使用的每个参数:

参数说明必选或可选
"StackName"

VPC 的唯一名称标签,用于帮助您识别它。

可选;如果未指定,则使用名称标签 arcgis-vpc 创建 VPC

"AZs"

VPC 指定两个 AWS 可用性区域。这些区域必须位于在 "AWSCredentials" 节点下指定的区域内。

如果文件包含 "NetworkStack" 节点,则 "AZs" 参数为必填参数。

"CreateFlag"

指定是创建 VPC (true) 还是不创建 (false)。

如果文件包含 "NetworkStack" 节点,则 "CreateFlag" 参数为必填参数。

ArcGIS Enterprise 文件

"ArcGISEnterpriseFiles" 部分包含实用程序创建部署时所需的许可和 SSL 文件的相关信息。

ArcGIS Server 许可文件可以为 .prvc.ecp 文件。Portal for ArcGIS 许可位于 .json 文件中。

SSL 文件必须为 .pfx 文件。

下面是指定了所有可能的参数的 "ArcGISEnterpriseFiles" 部分示例:

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

下表包含可在 "ArcGISEnterpriseFiles" 节点中使用的每个参数的说明:

参数说明必选或可选
"PortalLicense"

Portal for ArcGIS 许可文件 (.json)。

指定许可文件在本地磁盘上的物理路径,以便实用程序可将其上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的部署 S3 存储段。

如果部署了 ArcGIS Enterprise,则为必填参数。

"ServerLicense"

ArcGIS GIS Server 许可文件。

如果部署了 ArcGIS Enterprise 或联合或独立 ArcGIS GIS Server 站点,则为必填参数。

"ImageServerLicense"

ArcGIS Image Server 许可文件。

如果部署了联合或独立 ArcGIS Image Server,则为必填参数。

"GeoAnalyticsLicense"

ArcGIS GeoAnalytics Server 许可文件。

如果部署了 ArcGIS GeoAnalytics Server 站点,则为必填参数。

"NotebookServerLicense"

ArcGIS Notebook Server 许可文件。

如果部署了 ArcGIS Notebook Server 站点,则为必填参数。

"MissionServerLicense"

ArcGIS Mission Server 许可文件。

如果部署了 ArcGIS Mission Server 站点,则为必填参数。

"RasterAnalyticsLicense"

ArcGIS Image Server 许可文件。

如果部署了联合 ArcGIS Image Server,则为必填参数。

"ImageHostingLicense"

ArcGIS Image Server 许可文件。

如果部署了联合 ArcGIS Image Server,则为必填参数。

"GeoEventLicense"

ArcGIS GeoEvent Server 许可文件。

如果部署了联合或独立 ArcGIS GeoEvent Server,则为必填参数。

"SSLCertificateFile"

发布到站点域的 SSL 证书文件。

指定 SSL 证书在本地磁盘上的物理路径,以便实用程序可以将其上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的部署 S3 存储段。

上传 SSL 证书时需要。

"SSLCertPassword"

SSL 证书的密码。

上传 SSL 证书时需要。

要在用于部署创建的文件中使用的参数

要创建部署,需要提供要在部署中包含的软件和硬件的相关信息。参数将分组到以下几节中介绍的节点下。

部署详细信息

在文件的顶部,指定将用于部署中的每个 Amazon Elastic Compute Cloud 实例(计算机)的名称、要部署的 ArcGIS 软件版本(10.6 或更高版本)以及要用于所部署的 EC2 实例的操作系统(Microsoft WindowsUbuntu Server)。所有这些参数均为必填参数。

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

"DeploymentName" 参数必须以字母字符开头,只能包含字母数字字符,长度必须至少为三个字符。

在此示例中,部署中所有计算机的名称都将以 testservers 开头。10.8 Esri Ubuntu Amazon Machine Images (AMIs) 将用于部署。

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

CloudFormation 参数

Amazon Web Services CloudFormation 模板所需的参数将在以下节点下组织:

  • "Default" - 此处设置的参数适用于部署的所有部分。可在其他节点中忽略 Default 下设置的参数。
  • "BaseEnterprise" - 此部分中设置的参数仅适用于基础 ArcGIS Enterprise 部署。
  • "GeoAnalytics" - 此部分中设置的参数仅适用于联合 ArcGIS GeoAnalytics Server 站点。
  • "NotebookServer" - 此部分中设置的参数仅适用于联合 ArcGIS Notebook Server 站点。
  • "MissionServer" - 此部分中设置的参数仅适用于联合 ArcGIS Mission Server 站点。
  • "RasterAnalytics" - 此部分中设置的参数仅适用于联合或独立 ArcGIS Image Server 站点。
  • "ImageHosting" - 在本部分中设置的参数仅适用于将用作门户的影像托管服务器的联合 ArcGIS Image Server 站点。
  • "Server" - 此部分中设置的参数仅适用于联合或独立 ArcGIS GIS Server 站点。
  • "ImageServer" - 此部分中设置的参数仅适用于联合或独立 ArcGIS Image Server 站点。
  • "GeoEvent" - 此部分中设置的参数仅适用于联合或独立 ArcGIS GeoEvent Server 站点。

注:

必须包含与要创建的部署的每个部分对应的节点。例如,如果要创建基础 ArcGIS Enterprise 部署、联合 ArcGIS GeoAnalytics Server 站点和联合 ArcGIS GIS Server 站点,则配置文件中必须包含 "BaseEnterprise""GeoAnalytics""Server" 节点,并且这些节点必须至少包含一个参数。例如,即使在 "Default" 节点下设置了 "Federate""ServerLicenseFile" 参数,也必须在 "Server" 节点下至少包括这两个参数中的一个;如果不这样做,实用程序将不会创建联合 ArcGIS GIS Server 站点。

必须在 "Default" 节点下定义 VPC 设置。可以使用 "VPCId""Subnet1""Subnet2" 参数来定义 VPC,或者如果想要重新使用此工具或 Esri CloudFormation模板创建的现有部署中的 VPC,则可改为在 "NetworkStackName" 参数下指定部署的名称。以下是这些参数的说明:

参数说明必选或可选
"VPCId"

创建 VPC 时,AWS 会以 vpc-xxxxxxxx 格式向其分配 ID。在此为 VPC 提供 ID。

使用 ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序准备部署时,此 ID 将在使用 PREP 命令运行该实用程序时创建的输出文件中列出。

如果未指定 "NetworkStackName" 参数,则为必填参数。

"Subnet1"

VPC 中其中一个子网的 ID。

使用 ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序准备部署时,此 ID 将在使用 PREP 命令运行该实用程序时创建的输出文件中列出。

如果未指定 "NetworkStackName" 参数,则为必填参数。

"Subnet2"

VPC 中第二个子网的 ID。

使用 ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序准备部署时,此 ID 将在使用 PREP 命令运行该实用程序时创建的输出文件中列出。

如果未指定 "NetworkStackName" 参数,则为必填参数。

"NetworkStackName"

分配给现有 VPC 的名称标签。

如果未指定 "VPCId""Subnet1""Subnet2" 参数,则为必填参数。

"Default" 节点下定义的其他参数值适用于 JSON 文件中的部分或全部其他节点。Esri 建议使用 Default 节点来定义适用于部署中的多个节点的参数和值。这样可缩短配置文件并避免参数和值重复。例如,如果部署基础 ArcGIS Enterprise 和联合 ArcGIS GeoEvent Server,并使用通配符 SSL 证书,则需要在 "Default" 节点下指定 "SSLCertificateFile""SSLCertPassword" 参数,因为部署中的所有计算机都将使用相同证书。

以下示例使用了 "VPCId""Subnet1""Subnet2" 参数定义 VPC。根驱动器大小 ("DriveSizeRoot")、S3 存储段、管理员用户名和密码以及软件服务的密码 ("RunAsUserPassword") 适用于此部署的所有部分。由于部署中的所有 ArcGIS Server 站点将与门户联合,因此 "Federate": true 也会包含在 "Default" 节点下。

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

如果在特定部署节点中定义了参数值,则在该节点中指定的值将用于部署的该部分。例如,如果在 "BaseEnterprise""Default" 节点中定义了 "InstanceType" 参数,则在 "BaseEnterprise" 节点中定义的 "InstanceType" 值将用于 ArcGIS Enterprise 基础部署计算机,但是为 "Default" 节点定义的 "InstanceType" 值将用于使用此 JSON 文件部署的 ArcGIS GeoAnalytics ServerArcGIS GIS ServerArcGIS Image ServerArcGIS GeoEvent Server 站点。

基础 ArcGIS Enterprise 的参数

"BaseEnterprise" 节点下指定的参数值仅适用于通过用于部署 ArcGIS EnterpriseEsri CloudFormation 模板创建的 ArcGIS Enterprise 堆栈。可以将以下任何参数用于部署的基础 ArcGIS Enterprise 部分:

参数说明必选或可选
"DriveSizeRoot"

ArcGIS Enterprise 计算机的 C: 或根驱动器的大小(以 GB 为单位)。

如果未在 "Default" 节点下指定此项,则为必填参数。

"InstanceType"

要用于 ArcGIS Enterprise 计算机的 Amazon Elastic Compute Cloud 实例类型。

如果在一台计算机上部署了基础 ArcGIS Enterprise,则为必填参数。(将 "Type" 参数设置为 "AllInOne"。)

"FSInstanceType"

要用于文件服务器的 Amazon Elastic Compute Cloud 实例类型。

如果创建了高可用性 ArcGIS Enterprise 部署,则为必填参数。(将 "Type" 参数设置为 "HA"。)

"ASInstanceType"

要用于托管服务器的 Amazon Elastic Compute Cloud 实例类型。

如果创建了高可用性 ArcGIS Enterprise 部署,则为必填参数。(将 "Type" 参数设置为 "HA"。)

"BDSInstanceType"

要用于时空大数据存储计算机的 Amazon Elastic Compute Cloud 实例类型。

如果未在 "Default" 节点下指定此项,则为必填参数。

即使最初未部署时空大数据存储,也必须指定一个实例类型,以便在堆栈中配置自动伸缩。

"BDSInstances"

要为时空大数据存储创建的 EC2 实例数。如果此时不想在部署中包含时空大数据存储,则可以指定 "0"。否则,需要指定所需的实例数。

如果未在 "Default" 节点下指定此项,则为必填参数。

"KeyName"

用于远程访问 EC2 实例的 Amazon Elastic Compute Cloud 密钥对。

如果未在 "Default" 节点下指定此项,则为必填参数。

"StoreType"

ArcGIS Server 配置存储和 Portal for ArcGIS 内容目录的存储位置类型。

要使用 EC2 计算机,需要将此参数设置为 "FileSystem"。要将 S3 存储段用于门户内容目录,并将 S3 存储段和 Amazon DynamoDB 表用于门户内容目录,需要将此参数设置为 "CloudStore"

如果未在 "Default" 节点下指定此项,则为必填参数。

"ServerLicenseFile"

托管服务器的 ArcGIS GIS Server 许可文件的名字。必须将此文件上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的 S3 存储段。

如果未在 "Default" 节点下指定此项,则为必填参数。

"UserLicenseTypeID"

在您从 Esri 收到的 Portal for ArcGIS 许可文件中,包含您获得许可,可在门户中使用的用户类型的标识符 (ID)。其中一部分可用于初始管理员。

文件中的 ID 可能有所不同,但典型的 ID 包括但不限于:creatorUTGISProfessionalStdUTeditorUT。这些 ID 区分大小写,因此请务必按照 Portal for ArcGIS 许可 .json 文件中所示进行输入。

指定相应用户 ID。确保 Portal for ArcGIS 许可文件中存在此用户 ID

"PortalLicenseFile"

Portal for ArcGIS 许可文件的名称。必须将此文件上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的 S3 存储段。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdmin"

ArcGIS Server 主站点管理员的用户名和 Portal for ArcGIS 初始管理员帐户。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdminPassword"

站点管理员帐户的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteEIPAllocationID"

"Default" CloudFormation 参数下指定的 VPC 弹性 IP 地址的分配 ID。

如果在一台计算机上部署了基础 ArcGIS Enterprise,则为必填参数。(将 "Type" 参数设置为 "AllInOne"。)

"RunAsUserPassword"

用于运行 ArcGIS ServerPortal for ArcGISArcGIS Data Store Windows 服务的帐户密码。登录名始终为 ArcGIS。

如果您在 Windows 计算机上部署(将 "DeploymentDetails" 下的 "OperatingSystem" 参数设置为 "Windows")并且未在 "Default" 节点下指定此参数,则为必填参数。

"SSLCertificateFile"

发布到站点域的 SSL 证书文件。这必须为您上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的部署 S3 存储段的 .pfx 文件。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SSLCertPassword"

SSL 证书的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteDomain"

部署的域名。

如果使用 AWS Route 53 管理域名服务器,并因此设置了 DNS 参数设置下的 "AWSR53ZoneId" 参数,则可以指定子域名。如果未指定子域名,则将使用基于默认命名约定的域名。

如果未使用 AWS Route 53 来管理域名服务器,并且未设置 "AWSR53ZoneId" 参数,则必须为 "SiteDomain" 参数指定完全限定域名。

如果您使用自己的 DNS 服务器来管理域名而不是使用 AWS Route 53,请确保在运行 ArcGIS Enterprise Cloud Builder CLI for AWS 之前,已将域名 ("SiteDomain") 映射到 DNS 中的相应弹性负载均衡器或弹性 IP 地址,这样联合时域名才会有效。可以创建弹性负载均衡器(使用 AWS Management ConsoleEsri AWS CloudFormation 模板)或弹性 IP 地址(使用 AWS Management Console)。

如果未在 "Default" 节点下指定此项,则为必填参数。

"PostInstallationScript"

包含自定义安装后脚本的 zip 存档文件名,或者如果没有自定义脚本,则需要将此参数设置为 "NONE"

使用自定义安装后脚本时,必须将 zip 文件上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的部署 Amazon S3 存储段。

如果未在 "Default" 节点下指定此项,则为必填参数。

"TemplateURL"

如果您想要将自己的 CloudFormation 模板用于此部署,而不是使用由 Esri 提供的模板,则可以定义您自己的模板。提供有效的 HTTPS URL。

此参数可选,但如果要指定此参数,必须在 "BaseEnterprise" 节点下指定,而不是在 "Default" 节点。

"Type"

可能的值为 "AllInOne"(在一台计算机上部署所有部署部分)或 "HA"(创建高可用性部署)。

必填项。此参数必须在 "BaseEnterprise" 节点下指定,而非在 "Default" 节点下指定。

"ELBName"

指定使用 Esri AWS CloudFormation 模板创建的现有弹性负载均衡器的名称,或将此参数设置为 "NEW_ELB" 来创建新名称以供使用。如果将 "ELBName" 设置为 "NEW_ELB",则 AWS 会为其创建的负载均衡器分配一个名称。

必须如所示输入 "NEW_ELB",字母全部大写。

如果创建了高可用性 ArcGIS Enterprise 部署(将 "Type" 参数设置为 "HA"),则为必填参数。

ArcGIS GeoAnalytics ServerArcGIS Image ServerArcGIS GIS Server 站点参数以及栅格分析和影像托管服务器

"GeoAnalytics""RasterAnalytics""ImageHosting""ImageServer""Server" 节点下指定的参数值使用用于启动联合或独立 ArcGIS Server 站点的 Esri CloudFormation 模板。请注意,ArcGIS GeoAnalytics Server 站点一定要与 ArcGIS Enterprise 门户联合,要将 ArcGIS Image Server 站点用作栅格分析服务器或影像托管服务器,则该站点必须与门户联合。

创建联合 ArcGIS GeoAnalytics ServerArcGIS Image Server 站点时,ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序会将这些站点分别配置为门户的 GeoAnalytics、栅格分析和影像托管服务器;无需手动配置。

下表列出了可在 "GeoAnalytics""RasterAnalytics""ImageHosting""ImageServer""Server" 节点下设置的所有可能参数。

参数说明必选或可选
"ServerLicenseFile"

用于许可 ArcGIS GeoAnalytics ServerArcGIS Image ServerArcGIS GIS Server 站点的 .prvc.epc 文件。

必填项。

"CloudStoreS3BucketPath"

采用 <bucket_name>/<folder_name> 格式的存储段路径。

"RasterAnalytics""ImageHosting" 节点下使用时,实用程序会将此位置注册为站点的栅格存储。在其他节点下使用时,实用程序会将指定的位置注册为云存储。必须以指定的格式指定位置:<bucket_name>/<folder_name>。确保 S3 存储段存在并可通过在 "AWSCredentials" 节点下提供的 AWS 凭证访问。如果该存储段不存在,Cloud Builder 将使用 <deployment_name>+rastore 的默认命名约定创建存储段。如果存储段中不含指定的 <folder_name>,则 Cloud Builder 会创建一个。

对于用作门户的栅格分析服务器的 ArcGIS Image Server 站点,为必填参数。

如果创建了独立或联合 ArcGIS Image ServerArcGIS GIS Server 站点,则此参数为可选参数。

注:

如果您的部署包括 "RasterAnalytics""ImageHosting" 节点,并且您计划为这两个节点使用相同的栅格存储,请在这两个节点下使用相同的 "CloudStoreS3BucketPath" 参数值。

"Federate"

指定站点将与基础 ArcGIS Enterprise 部署联合 (true) 还是与独立站点联合 (false)。

创建 ArcGIS GeoAnalytics Server、栅格分析或 ArcGIS Image Server 站点时,必须将 "Federate" 设置为 true

如果未在部署配置文件中指定此参数,则默认值为 false

必填项。

"DriveSizeRoot"

ArcGIS GeoAnalytics ServerArcGIS Image ServerArcGIS GIS Server 计算机的 C: 或根驱动器的大小(以 GB 为单位)。

如果未在 "Default" 节点下指定此项,则为必填参数。

"FSInstanceType"

要用于文件服务器的 Amazon Elastic Compute Cloud 实例类型。

如果未在 "Default" 节点下指定此项,则为必填参数。

"ASInstanceType"

要用于 ArcGIS GeoAnalytics ServerArcGIS Image ServerArcGIS GIS Server 计算机的 Amazon Elastic Compute Cloud 实例类型。

如果未在 "Default" 节点下指定此项,则为必填参数。

"ASInstances"

通过自动伸缩启动的 Amazon Elastic Compute Cloud 实例数。该数值应该与构成 ArcGIS Server 站点的计算机总数相同。

如果未在 "Default" 节点下指定此项,则为必填参数。

"KeyName"

用于远程访问 EC2 实例的 Amazon Elastic Compute Cloud 密钥对。

如果未在 "Default" 节点下指定此项,则为必填参数。

"StoreType"

ArcGIS Server 站点配置存储的存储位置类型。

要使用 EC2 计算机,需要将此参数设置为 "FileSystem"。要将 S3 存储段用于门户内容目录,并将 S3 存储段和 Amazon DynamoDB 表用于门户内容目录,需要将此参数设置为 "CloudStore"

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdmin"

ArcGIS Server 主站点管理员的用户名。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdminPassword"

站点管理员帐户的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"RunAsUserPassword"

用于运行 ArcGIS Server Windows 服务的帐户的密码。登录名始终为 ArcGIS。

如果您在 Windows 计算机上部署(将 "DeploymentDetails" 下的 "OperatingSystem" 参数设置为 "Windows")并且未在 "Default" 节点下指定此参数,则为必填参数。

"ELBName"

指定使用 Esri AWS CloudFormation 模板创建的现有弹性负载均衡器的名称,或将此参数设置为 "NEW_ELB" 来创建新名称以供使用。如果将 "ELBName" 设置为 "NEW_ELB",则 AWS 会为其创建的负载均衡器分配一个名称。

必须如所示输入 "NEW_ELB",字母全部大写。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SSLCertificateARN"

发布到站点域的 SSL 证书的 Amazon 资源名称 (ARN)。

仅当您不使用现有弹性负载均衡器时,才为必填参数。

"SiteDomain"

部署的域名。

如果使用 AWS Route 53 管理域名服务器 (DNS),并因此设置了 DNS 参数设置下的 "AWSR53ZoneId" 参数,则可以指定子域名。如果未指定子域名,则将使用基于默认命名约定的域名。

如果您使用自己的 DNS 服务器来管理域名,而非使用 AWS Route 53,则为必填参数。

"DBEngine"

如果您要部署 Windows Amazon Elastic Compute Cloud 实例,则可将此参数设置为以下任意一项:

  • "none" - 不会创建 Amazon 关系数据库服务实例。
  • "sqlserver-se" - 将创建 Amazon RDS for SQL Server 实例并将其注册到您的站点。
  • "postgres" - 将创建 Amazon RDS for PostgreSQL 实例并将其注册到您的站点。
  • "aurora-postgresql" - 将创建 Amazon Aurora PostgreSQL 实例并将其注册到您的站点。

如果您要部署 Ubuntu Amazon Elastic Compute Cloud 实例,则可将此参数设置为 "none""aurora-postgresql""postgres"

如果未在 "Default" 节点下指定此项,则为必填参数。

"DBInstanceClass"

Amazon 关系数据库服务实例的实例类。

如果未在 "Default" 节点下指定此参数并将 "DBEngine" 设置为 "sqlserver-se""postgres""aurora-postgresql",则为必填参数。

"DBAllocatedStorage"

Amazon 关系数据库服务实例的已分配存储大小(以 GB 为单位)。

如果未在 "Default" 节点下指定此参数并将 "DBEngine" 设置为 "sqlserver-se""postgres",则为必填参数。

"PostInstallationScript"

包含自定义安装后脚本的 zip 存档文件名,或者如果没有自定义脚本,则需要将此参数设置为 "NONE"

使用自定义安装后脚本时,必须将 zip 文件上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的部署 Amazon S3 存储段。

如果未在 "Default" 节点下指定此项,则为必填参数。

"TemplateURL"

如果您想要将自己的 CloudFormation 模板用于此部署,而不是使用由 Esri 提供的模板,则可以定义您自己的模板。提供有效的 HTTPS URL。

可选。如果要指定此参数,则必须在特定服务器节点下指定(、"GeoAnalytics""RasterAnalytics""ImageHosting""Server"),而不能在 "Default" 节点指定。

ArcGIS GeoEvent Server 站点的参数

"GeoEvent" 节点下指定的参数值使用 Esri ArcGIS GeoEvent Server CloudFormation 模板。

下表列出了可在 "GeoEvent" 节点下设置的所有可能参数。

参数说明必选或可选
"ServerLicenseFile"

用于许可 ArcGIS GeoEvent Server 站点的 .prvc.ecp 文件。

必需项

"Federate"

指定站点将与基础 ArcGIS Enterprise 部署联合 (true) 还是与独立站点联合 (false)。

如果未在部署配置文件中指定此参数,则默认值为 false

如果未在 "Default" 节点下指定此项,则为必填参数。

"DriveSizeRoot"

ArcGIS GeoEvent Server 计算机的 C: 或根驱动器的大小(以 GB 为单位)。

如果未在 "Default" 节点下指定此项,则为必填参数。

"ASInstanceType"

要用于 ArcGIS GeoEvent Server 计算机的 Amazon Elastic Compute Cloud 实例类型。

如果未在 "Default" 节点下指定此项,则为必填参数。

"FSInstanceType"

要用于文件服务器的 Amazon Elastic Compute Cloud 实例类型。

如果未在 "Default" 节点下指定此项,则为必填参数。

"ELBName"

指定使用 Esri AWS CloudFormation 模板创建的现有弹性负载均衡器的名称,或将此参数设置为 "NEW_ELB" 来创建新的弹性负载均衡器以供使用。

如果将 "ELBName" 设置为 "NEW_ELB",则 AWS 会为其创建的负载均衡器分配一个名称。

必须如所示输入 "NEW_ELB",字母全部大写。

如果未在 "Default" 节点下指定此项,则为必填参数。

"KeyName"

用于远程访问 EC2 实例的 Amazon Elastic Compute Cloud 密钥对。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdmin"

ArcGIS Server 主站点管理员的用户名。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdminPassword"

站点管理员帐户的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"RunAsUserPassword"

用于运行 ArcGIS Server Windows 服务的帐户的密码。登录名始终为 ArcGIS。

如果您在 Windows 计算机上部署(将 "DeploymentDetails" 下的 "OperatingSystem" 参数设置为 "Windows")并且未在 "Default" 节点下指定此参数,则为必填参数。

"SSLCertificateFile"

发布到站点域的 SSL 证书文件。此文件必须为之前上传到为 "DeploymentBucket" 指定的 S3 存储段的 .pfx 文件。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SSLCertPassword"

SSL 证书的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteDomain"

部署的域名。

如果使用 AWS Route 53 管理域名服务器 (DNS),并因此设置了 DNS 参数设置下的 "AWSR53ZoneId" 参数,则可以指定子域名。如果未指定子域名,则将使用基于默认命名约定的域名。

如果您使用自己的 DNS 服务器来管理域名,而非使用 AWS Route 53,则为必填参数。

"PostInstallationScript"

包含自定义安装后脚本的 zip 存档文件名,或者如果没有自定义脚本,则需要将此参数设置为 "NONE"

使用自定义安装后脚本时,必须将 zip 文件上传到 ArcGIS Enterprise Cloud Builder for AWS 托管的部署 S3 存储段。

如果未在 "Default" 节点下指定此项,则为必填参数。

"TemplateURL"

如果您想要将自己的 CloudFormation 模板用于此部署,而不是使用由 Esri 提供的模板,则可以定义您自己的模板。提供有效的 HTTPS URL。

可选。此参数必须在 "GeoEvent" 节点下指定,而非在 "Default" 节点下指定。

ArcGIS Notebook Server 站点的参数

您在 "NotebookServer" 节点下指定的参数值将使用可启动 ArcGIS Notebook Server 站点的 Esri CloudFormation 模板。请注意,ArcGIS Notebook Server 站点必须始终与 ArcGIS Enterprise 门户联合,并且您可以仅在 Ubuntu 操作系统上创建一个 ArcGIS Notebook Server 站点。

创建联合 ArcGIS Notebook Server 站点时,ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序会将这些站点分别配置为门户的 Notebook Server;无需手动配置。

下表列出了可在 "NotebookServer" 节点下设置的所有可能参数。

参数说明必选或可选
"ServerLicenseFile"

用于许可 ArcGIS Notebook Server 站点的 .prvc.ecp 文件。

必填项。

"Federate"

指定站点将与基础 ArcGIS Enterprise 部署联合 (true) 还是与独立站点联合 (false)。

创建 ArcGIS Notebook Server 站点时,必须将 "Federate" 设置为 true

如果未在部署配置文件中指定此参数,则默认值为 false

必填项。

"DriveSizeRoot"

ArcGIS Notebook Server 计算机的 C: 或根驱动器的大小(以 GB 为单位)。

如果未在 "Default" 节点下指定此项,则为必填参数。

"InstanceType"

要用于 ArcGIS Notebook Server 计算机的 Amazon Elastic Compute Cloud 实例类型。

如果未在 "Default" 节点下指定此项,则为必填参数。

"KeyName"

用于远程访问 EC2 实例的 Amazon Elastic Compute Cloud 密钥对。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdmin"

ArcGIS Server 主站点管理员的用户名。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdminPassword"

站点管理员帐户的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteDomain"

部署的域名。

如果使用 AWS Route 53 管理域名服务器 (DNS),并因此设置了 DNS 参数设置下的 "AWSR53ZoneId" 参数,则可以指定子域名。如果未指定子域名,则将使用基于默认命名约定的域名。

如果您使用自己的 DNS 服务器来管理域名,而非使用 AWS Route 53,则为必填参数。

"SSLCertificateFile"

发布到站点域的 SSL 证书文件。此文件必须为之前上传到您所指定的、由 ArcGIS Enterprise Cloud Builder for AWS 管理的 S3 存储段的 .pfx 文件。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SSLCertPassword"

SSL 证书的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteEIPAllocationID"

"NotebookServer" CloudFormation 参数下指定的 VPC 弹性 IP 地址的分配 ID。

必填,并且必须位于 "NotebookServer" 节点之下。

"AdditionalInstances"

ArcGIS Notebook Server 站点中需要的附加计算机数。默认值为零 (0)。

如果指定 0,则 ArcGIS Notebook Server 站点将仅包含一台计算机。

必填,并且必须位于 "NotebookServer" 节点之下。

"BaseAMI"

Amazon Machine Image ID 用于创建 ArcGIS Notebook Server 站点。

可选。

"TemplateURL"

如果您想要将自己的 CloudFormation 模板用于此部署,而不是使用由 Esri 提供的模板,则可以定义您自己的模板。提供有效的 HTTPS URL。

可选。此参数必须在 "NotebookServer" 节点下指定,而非在 "Default" 节点下指定。

ArcGIS Mission Server 站点的参数

您在 "MissionServer" 节点下指定的参数值将使用可启动 ArcGIS Mission Server 站点的 EsriCloudFormation 模板。请注意, ArcGIS Mission Server 站点必须始终与 ArcGIS Enterprise 门户联合。

创建联合 ArcGIS Mission Server 站点时,ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序会将这些站点分别配置为门户的 Server;无需手动配置。

下表列出了可在 "MissionServer" 节点下设置的所有可能参数。

参数说明必选或可选
"ServerLicenseFile"

用于许可 ArcGIS Mission Server 站点的 .prvc.ecp 文件。

必填项。

"Federate"

指定站点将与基础 ArcGIS Enterprise 部署联合 (true) 还是与独立站点联合 (false)。

创建 ArcGIS Mission Server 站点时,必须将 "Federate" 设置为 true

如果未在部署配置文件中指定此参数,则默认值为 false

必填项。

"DriveSizeRoot"

ArcGIS Mission Server 计算机的 C: 或根驱动器的大小(以 GB 为单位)。

如果未在 "Default" 节点下指定此项,则为必填参数。

"InstanceType"

要用于 ArcGIS Notebook Server 计算机的 Amazon Elastic Compute Cloud 实例类型。

如果未在 "Default" 节点下指定此项,则为必填参数。

"KeyName"

用于远程访问 EC2 实例的 Amazon Elastic Compute Cloud 密钥对。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdmin"

ArcGIS Server 主站点管理员的用户名。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteAdminPassword"

站点管理员帐户的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteDomain"

部署的域名。

如果使用 AWS Route 53 管理域名服务器 (DNS),并因此设置了 DNS 参数设置下的 "AWSR53ZoneId" 参数,则可以指定子域名。如果未指定子域名,则将使用基于默认命名约定的域名。

如果您使用自己的 DNS 服务器来管理域名,而非使用 AWS Route 53,则为必填参数。

"SSLCertificateFile"

发布到站点域的 SSL 证书文件。此文件必须为之前上传到您所指定的、由 ArcGIS Enterprise Cloud Builder for AWS 管理的 S3 存储段的 .pfx 文件。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SSLCertPassword"

SSL 证书的密码。

如果未在 "Default" 节点下指定此项,则为必填参数。

"SiteEIPAllocationID"

"MissionServer" CloudFormation 参数下指定的 VPC 弹性 IP 地址的分配 ID。

必填,并且必须位于 "MissionServer" 节点之下。

"RunAsUserPassword"

用于运行 ArcGIS Server Windows 服务的帐户的密码。登录名始终为 ArcGIS。

如果您在 Windows 计算机上部署(将 "DeploymentDetails" 下的 "OperatingSystem" 参数设置为 "Windows")并且未在 "Default" 节点下指定此参数,则为必填参数。

"BaseAMI"

Amazon Machine Image ID 用于创建 ArcGIS Mission Server 站点。

可选。

"TemplateURL"

如果您想要将自己的 CloudFormation 模板用于此部署,而不是使用由 Esri 提供的模板,则可以定义您自己的模板。提供有效的 HTTPS URL。

可选。此参数必须在 "MissionServer" 节点下指定,而非在 "Default" 节点下指定。

DNS 参数

使用 AWS Route 53 管理域名服务器 (DNS) 时,必须在 "DNSParameters" 节点下定义 AWS Route 53 区域 ID。运行 ArcGIS Enterprise Cloud Builder CLI for AWS 实用程序时,它会更新 DNS 以将每个域名 ("SiteDomain") 映射到对应的弹性负载平衡器 (ELB) 或弹性 IP 地址 (EIP)。

使用 AWS Route 53 时,该参数为必填参数。如果不使用 AWS Route 53,则可以将此参数留空。

在此示例中,AWS Route 53 区域 ZUJQ3S2DAL123 将映射到为基础部署 "SiteDomain" 参数指定的弹性 IP 地址。

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