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

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

DescribedServer

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

Contents

Arn

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

类型: 字符串

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

模式:arn:.*

:必需 是

证书

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

类型: 字符串

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

:必需 否

Domain

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

类型: 字符串

有效值: S3 | EFS

:必需 否

EndpointDetails

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

类型:EndpointDetails 对象

:必需 否

EndpointType

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

类型: 字符串

有效值: PUBLIC | VPC | VPC_ENDPOINT

:必需 否

主机键指纹

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

类型: 字符串

:必需 否

IdentityProviderDetails

指定调用客户提供的身份验证 API 的信息。当IdentityProviderType的服务器是AWS_DIRECTORY_SERVICE或者SERVICE_MANAGED.

类型:IdentityProviderDetails 对象

:必需 否

IdentityProviderType

指定服务器的身份验证模式。默认值是 。SERVICE_MANAGED,这允许您在AmazonTransfer 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

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

类型: 字符串

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

模式:arn:.*role/.*

:必需 否

协议详细信息

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

使用PassiveIp参数来指示被动模式。输入单个点四通道 IPv4 地址,例如防火墙、路由器或负载平衡器的外部 IP 地址。

类型:ProtocolDetails 对象

:必需 否

协议

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

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

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

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

类型: 字符串数组

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

有效值: SFTP | FTP | FTPS

:必需 否

SecurityPolicyName

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

类型: 字符串

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

模式:TransferSecurityPolicy-.+

:必需 否

ServerId

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

类型: 字符串

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

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

:必需 否

State

指定所描述的服务器的服务器的条件。值是ONLINE表示服务器可以接受作业和传输文件。AState对于是必需的OFFLINE意味着服务器无法执行文件传输操作。

状态STARTINGSTOPPING表示服务器处于中间状态,要么无法完全响应,要么不完全脱机。对于是必需的START_FAILED或者STOP_FAILED可以指示错误情形。

类型: 字符串

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

:必需 否

标签

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

类型: 数组Tagobjects

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

:必需 否

UserCount

指定分配给使用ServerId.

类型: 整数

:必需 否

另请参阅

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