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

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

DescribedServer

描述指定的启用文件传输协议的服务器的属性。

内容

Arn

指定服务器的唯一 Amazon 资源名称 (ARN)。

类型:字符串

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

模式:arn:\S+

必需:是

As2ServiceManagedEgressIpAddresses

此服务器的出口 IP 地址列表。这些 IP 地址仅与使用 AS2 协议的服务器相关。它们用于发送异步 mDN。

这些 IP 地址是在您创建 AS2 服务器时自动分配的。此外,如果您更新现有服务器并添加 AS2 协议,则还会分配静态 IP 地址。

类型:字符串数组

模式:\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

必需:否

Certificate

指定 AmazonCertificate Manager (ACM) 证书的 ARN。在 Protocols 设置为 FTPS 时是必需的。

类型:字符串

长度限制:长度下限为 0。长度上限为 1600。

必需:否

Domain

指定用于文件传输的存储系统的域。

类型:字符串

有效值:S3 | EFS

必需:否

EndpointDetails

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

类型:EndpointDetails 对象

必需:否

EndpointType

定义服务器连接到的端点类型。如果您的服务器连接到 VPC 端点,则无法通过公共互联网访问您的服务器。

类型:字符串

有效值:PUBLIC | VPC | VPC_ENDPOINT

必需:否

HostKeyFingerprint

指定服务器主机密钥的 Base64 编码的 SHA256 指纹。该值等效于 ssh-keygen -l -f my-new-server-key 命令的输出。

类型:字符串

必需:否

IdentityProviderDetails

指定调用客户提供的身份验证 API 的信息。当服务器的 IdentityProviderTypeAWS_DIRECTORY_SERVICESERVICE_MANAGED 时,不会填充此字段。

类型:IdentityProviderDetails 对象

必需:否

IdentityProviderType

服务器的身份验证模式。默认值为 SERVICE_MANAGED,这允许您在 Amazon Transfer Family 服务中存储和访问用户凭证。

使用 AWS_DIRECTORY_SERVICE 可以访问 Active Directory 组,这些组位于本地环境中或使用 AD Connector 的 Amazon Directory Service for Microsoft Active Directory 的 Amazon 或 Microsoft Active Directory 中。此选项还要求您使用 IdentityProviderDetails 参数提供 Directory ID。

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

使用 AWS_LAMBDA 值直接将 Amazon Lambda 函数用作身份提供者。如果选择该值,则必须在 Function 数据类型的 IdentityProviderDetails 参数中指定 Lambda 函数的 ARN。

类型:字符串

有效值:SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

必需:否

LoggingRole

(IAM) 角色的亚马逊资源名称 (ARN),允许服务器为亚马逊 S3 或 Amazon efSevents 开启亚马逊 CloudWatch 日志记录。Amazon Identity and Access Management设置后,您可以在 CloudWatch 日志中查看用户活动。

类型:字符串

长度约束:最小长度为 0。最大长度为 2048。

模式:(|arn:.*role/\S+)

必需:否

PostAuthenticationLoginBanner

指定用户连接到服务器时要显示的字符串。此字符串在用户进行身份验证后显示。

注意

SFTP 协议不支持身份验证后显示横幅。

类型:字符串

长度限制:长度下限为 0。最大长度为 4096。

模式:[\x09-\x0D\x20-\x7E]*

必需:否

PreAuthenticationLoginBanner

指定用户连接到服务器时要显示的字符串。此字符串在用户进行身份验证前显示。例如,以下横幅显示有关使用系统的详细信息:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

类型:字符串

长度限制:长度下限为 0。最大长度为 4096。

模式:[\x09-\x0D\x20-\x7E]*

必需:否

ProtocolDetails

为服务器配置的协议设置。

  • 要指示被动模式(适用于 FTP 和 FTPS 协议),请使用 PassiveIp 参数。输入一个点分四组的 IPv4 地址,例如防火墙、路由器或负载均衡器的外部 IP 地址。

  • 要忽略当客户端尝试对您上传到 S3 桶的文件使用 SETSTAT 命令时生成的错误,请使用 SetStatOption 参数。要使 Amazon Transfer Family 服务器忽略 SETSTAT 命令,并上传文件而无需对您的 SFTP 客户端进行任何更改,将该值设置为 ENABLE_NO_OP。如果您将SetStatOption参数设置为ENABLE_NO_OP,Transfer Family 会生成一个到 Amazon Logs 的 CloudWatch 日志条目,以便您可以确定客户何时SETSTAT拨打电话。

  • 要确定 Amazon Transfer Family 服务器是否会通过唯一的会话 ID 恢复最近协商的会话,请使用 TlsSessionResumptionMode 参数。

  • As2Transports 指示 AS2 消息的传输方法。目前仅支持 HTTP。

类型:ProtocolDetails 对象

必需:否

Protocols

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

  • SFTP(Secure Shell (SSH) 文件传输协议):通过 SSH 的文件传输

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

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

  • AS2(适用性声明 2):用于传输结构化 business-to-business 数据

注意
  • 如果选择 FTPS,则必须选择存储在 Amazon Certificate Manager(ACM)中的证书,该证书将用于在客户端通过 FTPS 连接到服务器时标识服务器。

  • 如果 Protocol 包括 FTPFTPS,则 EndpointType 必须为 VPC,且 IdentityProviderType 必须为 AWS_DIRECTORY_SERVICEAWS_LAMBDAAPI_GATEWAY

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

  • 如果仅将 Protocol 设置为 SFTP,则可以将 EndpointType 设置为 PUBLIC,并且可以将 IdentityProviderType 设置为任何支持的身份类型:SERVICE_MANAGEDAWS_DIRECTORY_SERVICEAWS_LAMBDAAPI_GATEWAY

  • 如果 Protocol 包括 AS2,则 EndpointType 必须是 VPC,并且域必须是 Amazon S3。

类型:字符串数组

数组成员:最少 1 个物品。最多 4 项。

有效值:SFTP | FTP | FTPS | AS2

必需:否

S3StorageOptions

指定是否对您的 Amazon S3 目录的性能进行了优化。默认情况下,将禁用该功能。

默认情况下,主目录映射TYPE的值为。DIRECTORY如果启用此选项,则需要将显式设置为,HomeDirectoryMapEntryTypeFILE使映射具有文件目标。

类型:S3StorageOptions 对象

必需:否

SecurityPolicyName

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

类型:字符串

长度限制:长度下限为 0。最大长度为 100。

模式:TransferSecurityPolicy-.+

必需:否

ServerId

为您实例化的服务器指定系统分配的唯一标识符。

类型:字符串

长度限制:固定长度为 19。

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

必需:否

State

所描述的服务器的状况。值为 ONLINE 表示服务器可以接受作业和传输文件。State值为OFFLINE表示服务器无法执行文件传输操作。

状态STARTINGSTOPPING表示服务器处于中间状态,要么无法完全响应,要么未完全脱机。值START_FAILEDSTOP_FAILED可以表示错误情况。

类型:字符串

有效值:OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

必需:否

StructuredLogDestinations

指定将服务器日志发送到日志组。

要指定日志组,必须提供现有日志组的 ARN。在这种情况下,日志组的格式如下所示:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

例如,arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

如果您之前为服务器指定了日志组,则可以通过在update-server调用中为该参数提供空值来清除该日志组,从而关闭结构化日志记录。例如:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

类型:字符串数组

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

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

模式:arn:\S+

必需:否

Tags

指定可用于搜索和分组已分配给所描述服务器的服务器的键值对。

类型:Tag 对象数组

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

必需:否

UserCount

指定分配给您在ServerId中指定的服务器的用户数。

类型:整数

必需:否

WorkflowDetails

指定要分配的工作流的工作流 ID 以及用于执行工作流的执行角色。

除了要在文件完全上传时执行的工作流,WorkflowDetails 还可能包含在部分文件上传时执行的工作流的工作流 ID(和执行角色)。在文件仍在上传时,如果断开连接,则会发生部分上传。

类型:WorkflowDetails 对象

必需:否

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: