DescribedServer - AWS Transfer Family
内容另请参阅

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

DescribedServer

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

内容

Arn

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

类型：字符串

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

模式：arn:\S+

必需：是

As2ServiceManagedEgressIpAddresses

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

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

类型：字符串数组

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

必需：否

Certificate

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

类型：字符串

长度约束：最小长度为 0。长度上限为 1600。

必需：否

Domain

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

类型：字符串

有效值：S3 | EFS

必需：否

EndpointDetails

为您的服务器配置的虚拟私有云 (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的信息。当服务器的 IdentityProviderType 为 AWS_DIRECTORY_SERVICE 或 SERVICE_MANAGED 时，不会填充此字段。

类型：IdentityProviderDetails 对象

必需：否

IdentityProviderType

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

用于AWS_DIRECTORY_SERVICE访问本地环境中的活动目录组 AWS Directory Service for Microsoft Active Directory 或 Microsoft Active Directory 或 AWS 使用 AD Connector。此选项还要求您使用 IdentityProviderDetails 参数提供 Directory ID。

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

使用该AWS_LAMBDA值可直接使用 AWS Lambda 函数作为您的身份提供商。如果您选择此值，则必须在IdentityProviderDetails数据类型的Function参数中ARN为 Lambda 函数指定。

类型：字符串

有效值：SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

必需：否

LoggingRole

() 角色的亚马逊资源名称 AWS Identity and Access Management (ARNIAM)，允许服务器开启亚马逊 S3 或亚马逊的亚马逊 CloudWatch 日志记录EFSevents。设置后，您可以在 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 参数。要让 AWS Transfer Family 服务器忽略SETSTAT命令并上传文件而不必对您的SFTP客户端进行任何更改，请将该值设置为ENABLE_NO_OP。如果您将SetStatOption参数设置为ENABLE_NO_OP，Transfer Family 会生成一个到 Amazon Logs 的 CloudWatch 日志条目，以便您可以确定客户何时SETSTAT拨打电话。

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

  • As2Transports表示AS2邮件的传输方法。目前仅支持 HTTP。

类型：ProtocolDetails 对象

必需：否

Protocols

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

  • SFTP（Secure Shell (SSH) 文件传输协议）：通过文件传输 SSH

  • FTPS（安全文件传输协议）：TLS加密文件传输

  • FTP（文件传输协议）：未加密的文件传输

  • AS2（适用性声明 2）：用于传输结构化 business-to-business数据

注意

  • 如果选择FTPS，则必须选择存储在 AWS Certificate Manager (ACM) 中的证书，该证书用于在客户端连接到服务器时识别您的服务器FTPS。

  • 如果 Protocol 包括 FTP 或 FTPS，则 EndpointType 必须为 VPC，且 IdentityProviderType 必须为 AWS_DIRECTORY_SERVICE、AWS_LAMBDA 或 API_GATEWAY。

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

  • 如果仅将 Protocol 设置为 SFTP，则可以将 EndpointType 设置为 PUBLIC，并且可以将 IdentityProviderType 设置为任何支持的身份类型：SERVICE_MANAGED、AWS_DIRECTORY_SERVICE、AWS_LAMBDA 或 API_GATEWAY。

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

类型：字符串数组

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

有效值：SFTP | FTP | FTPS | AS2

必需：否

S3StorageOptions

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

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

类型：S3StorageOptions 对象

必需：否

SecurityPolicyName

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

类型：字符串

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

模式：TransferSecurityPolicy-.+

必需：否

ServerId

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

类型：字符串

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

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

必需：否

State

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

状态 STARTING 和 STOPPING 表示服务器处于中间状态，要么无法完全响应，要么未完全脱机。值 START_FAILED 或 STOP_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 对象

必需：否

另请参阅

有关在特定语言API中使用它的更多信息 AWS SDKs，请参阅以下内容：