CreateServer - Amazon Transfer Family
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateServer

基于中选定的文件传输协议实例化 auto-scaling 虚拟服务器。Amazon. 当您更新启用文件传输协议的服务器或与用户一起工作时,使用服务生成的ServerId属性,该属性分配给新创建的服务器。

请求语法

{ "Certificate": "string", "Domain": "string", "EndpointDetails": { "AddressAllocationIds": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcEndpointId": "string", "VpcId": "string" }, "EndpointType": "string", "HostKey": "string", "IdentityProviderDetails": { "DirectoryId": "string", "InvocationRole": "string", "Url": "string" }, "IdentityProviderType": "string", "LoggingRole": "string", "Protocols": [ "string" ], "SecurityPolicyName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

请求参数

有关所有操作通用的参数的信息,请参阅常见参数.

请求接受采用 JSON 格式的以下数据。

证书

的 Amazon 资源名称 (ARN)AmazonCertificate Manager (ACM) 证书。在 Protocols 设置为 FTPS 时是必需的。

要请求新的公共证书,请参阅请求公有证书中的 AmazonCertificate Manager 用户指.

要将现有证书导入到 ACM,请参阅。将证书导入 ACM中的 AmazonCertificate Manager 用户指.

要请求私有证书以通过私有 IP 地址使用 FTPS,请参阅请求私有证书中的 AmazonCertificate Manager 用户指.

支持具有以下加密算法和密钥大小的证书:

  • 2048 位 RSA (RSA_2048)

  • 4096 位 RSA (RSA_4096)

  • Elliptic Prime Curve 256 位 (EC_prime256v1)

  • Elliptic Prime Curve 384 位 (EC_secp384r1)

  • Elliptic Prime Curve 521 位 (EC_secp521r1)

注意

证书必须是指定了 FQDN 或 IP 地址且具有有关颁发者的信息的有效 SSL/TLS X.509 版本 3 证书。

类型: 字符串

长度约束:长度上限为 1600。

:必需 否

Domain

用于文件传输的存储系统的域。有两个域可用:Amazon Simple Storage Service (Amazon S3) 和 Amazon Elastic File System (Amazon EFS)。默认值为 S3。

注意

创建服务器后,域便无法更改。

类型: 字符串

有效值: S3 | EFS

:必需 否

EndpointDetails

要为服务器配置的 Virtual Private Cloud (VPC) 终端节点设置。当您在 VPC 中托管终端节点时,您可以使其仅可供 VPC 内的资源访问,也可以附加弹性 IP 地址并使其可由客户端通过 Internet 访问。您 VPC 的默认安全组会自动分配到您的终端节点。

类型:EndpointDetails 对象

:必需 否

EndpointType

您希望服务器使用的终端节点的类型。您可以选择将服务器的终端节点公开访问 (PUBLIC) 或将其托管在您的 VPC 中。使用托管在 VPC 中的终端节点,您可以将对服务器和资源的访问权限限制在 VPC 内,也可以选择通过将弹性 IP 地址直接附加到 VPC,使其面向 Internet。

注意

在 2021 年 5 月 19 日之后,您将无法使用EndpointType=VPC_ENDPOINT在您的Amazon帐户(如果您的帐户在 2021 年 5 月 19 日之前尚未执行此操作)。如果您已经使用创建服务器EndpointType=VPC_ENDPOINT在您的Amazon帐户于 2021 年 5 月 19 日或之前,您将不会受到影响。在此日期之后,使用EndpointType=VPC.

有关更多信息,请参阅停止使用 VPC_端点

建议您使用 VPC 作为 EndpointType。使用此终端节点类型,您可以选择将最多三个弹性 IPv4 地址(包括 BYO IP)直接与服务器的终端节点相关联,并使用 VPC 安全组限制客户端的公有 IP 地址的流量。如果 EndpointType 设置为 VPC_ENDPOINT,则无法实现此操作。

类型: 字符串

有效值: PUBLIC | VPC | VPC_ENDPOINT

:必需 否

主机密钥

RSA 私钥由ssh-keygen -N "" -m PEM -f my-new-server-key命令。

重要

如果您不打算将现有用户从现有启用 SFTP 的服务器迁移到新服务器,请不要更新主机密钥。意外更改服务器的主机密钥会导致中断。

有关更多信息,请参阅 。更改启用 SFTP 的服务器的主机密钥中的 AmazonTTransfer Family.

类型: 字符串

长度约束:长度上限为 4096。

:必需 否

IdentityProviderDetails

在需要时IdentityProviderType设置为AWS_DIRECTORY_SERVICE或者API_GATEWAY. 接受包含使用AWS_DIRECTORY_SERVICE或调用客户提供的身份验证 API(包括 API Gateway URL)。在 IdentityProviderType 设置为 SERVICE_MANAGED 时不是必需的。

类型:IdentityProviderDetails 对象

:必需 否

IdentityProviderType

指定服务器的身份验证模式。默认值是 。SERVICE_MANAGED,这允许您在AmazonTTransfer Family

使用AWS_DIRECTORY_SERVICE以提供对活动目录组的访问权限Amazon托管活动目录或 Microsoft 活动目录在内部部署环境中或Amazon使用 AD 连接器。此选项还要求您使用IdentityProviderDetails参数。

使用 API_GATEWAY 值以与您选择的身份提供商集成。API_GATEWAY 设置要求您提供 API Gateway 终端节点 URL 以使用 IdentityProviderDetails 参数调用身份验证。

类型: 字符串

有效值: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE

:必需 否

LoggingRole

指定的 Amazon 资源名称 (ARN)AmazonIdentity and Access Management (IAM) 角色允许服务器为 Amazon S3 或 Amazon EFS 事件打开 Amazon CloudWatch 日志记录。设置后,可以在您的 CloudWatch 日志中查看用户活动。

类型: 字符串

长度约束:最小长度为 20。长度上限为 2048。

模式:arn:.*role/.*

:必需 否

协议

指定文件传输协议客户端可以用来连接到服务器终端节点的一个或多个文件传输协议。可用的协议包括:

  • SFTP(安全外壳 (SSH) 文件传输协议):通过 SSH 传输文件

  • FTPS(文件传输协议安全):使用 TLS 加密进行文件传输

  • FTP(文件传输协议):未加密的文件传输

注意

如果您选择FTPS,则必须选择存储在AmazonCertificate Manager (ACM),用于在客户端通过 FTPS 连接到服务器时标识服务器。

如果Protocol包括FTP或者FTPS,然后EndpointType必须是VPCIdentityProviderType必须是AWS_DIRECTORY_SERVICE或者API_GATEWAY.

如果 Protocol 包含 FTP,则无法关联 AddressAllocationIds

如果 Protocol 仅设置为 SFTP,则 EndpointType 可以设置为 PUBLIC,并且 IdentityProviderType 可以设置为 SERVICE_MANAGED

类型: 字符串数组

数组成员:最少 1 项。最多 3 项。

有效值: SFTP | FTP | FTPS

:必需 否

SecurityPolicyName

指定连接到服务器的安全策略的名称。

类型: 字符串

长度约束:长度上限为 100。

模式:TransferSecurityPolicy-.+

:必需 否

标签

可用于分组和搜索服务器的键/值对。

类型: 数组Tagobjects

数组成员:最少 1 项。最多 50 项。

:必需 否

响应语法

{ "ServerId": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

ServerId

创建的服务器的服务分配的 ID。

类型: 字符串

长度约束:固定长度为 19。

模式:^s-([0-9a-f]{17})$

Errors

有关所有操作常见错误的信息,请参阅常见错误.

AccessDeniedException

您没有足够的访问权限,无法执行该操作。

HTTP 状态代码:400

InternalServiceError

在AmazonTTransfer Family

HTTP 状态代码:500

InvalidRequestException

在客户端提交格式错误请求时,会引发此异常。

HTTP 状态代码:400

ResourceExistsException

请求的资源不存在。

HTTP 状态代码:400

ServiceUnavailableException

请求失败,因为Amazon酒店不提供 Transfer Family 服务。

HTTP 状态代码:500

ThrottlingException

由于请求限制而导致请求被拒绝。

HTTP 状态代码:400

HTTP 状态代码:400

Examples

Example

以下示例使用创建一个新服务器VPC_ENDPOINT.

示例请求

{ "EndpointType": "VPC", "EndpointDetails":..., "HostKey": "Your RSA private key", "IdentityProviderDetails": "IdentityProvider", "IdentityProviderType": "SERVICE_MANAGED", "LoggingRole": "CloudWatchLoggingRole", "Tags": [ { "Key": "Name", "Value": "MyServer" } ] }

Example

此示例说明了 CreateServer 的一种用法。

示例响应

{ "ServerId": "s-01234567890abcdef" }

另请参阅

有关在特定语言的特定语言的服务器中使用此 API 的更多信息。Amazon开发工具包,请参阅: