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

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

DescribedUser

描述指定用户的属性。

内容

Arn

为请求描述的用户指定唯一 Amazon 资源名称(ARN)。

类型:字符串

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

模式:arn:\S+

必需:是

HomeDirectory

用户使用客户端登录服务器时的登录目录(文件夹)。

HomeDirectory 示例为 /bucket_name/home/mydirectory

注意

HomeDirectory 参数仅在 HomeDirectoryType 设置为 PATH 时使用。

类型:字符串

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

模式:(|/.*)

必需:否

HomeDirectoryMappings

逻辑目录映射指定哪些 Amazon S3 或 Amazon EFS 路径和密钥应对您的用户可见,以及使其对用户可见的方式。您需要指定EntryTarget对,其中 Entry 显示如何使路径可见,Target 是实际的 Amazon S3 或 Amazon EFS 路径。如果您只指定一个目标,则将按原样显示。您还必须确保您的 Amazon Identity and Access Management (IAM) 角色提供对中路径的访问权限Target。只有当HomeDirectoryType设置为LOGICAL时,才能设置此值。

在大多数情况下,您可以使用此值而不是会话策略将您的用户锁定到指定的主目录(“chroot”)。为此,您可以设置Entry为 '/' 并设置Target为 HomeDirectory参数值。

类型:HomeDirectoryMapEntry 对象数组

数组成员:最少 1 个物品。最大数量为 50000 个。

必需:否

HomeDirectoryType

您希望用户在登录服务器时,用户主目录的登录目录(文件夹)的类型。如果您将其设置为PATH,则用户将在其文件传输协议客户端中原样看到 Amazon S3 存储桶或 Amazon EFS 的绝对路径。如果您将其设置为LOGICAL,则需要针对您希望如何使 Amazon S3 或 Amazon EFS 路径对用户可见,在HomeDirectoryMappings中提供映射。

注意

如果HomeDirectoryTypeLOGICAL,则必须使用HomeDirectoryMappings参数提供映射。另一方面,如果HomeDirectoryTypePATH,则使用HomeDirectory参数提供绝对路径。您的模板中不能同时使用HomeDirectoryHomeDirectoryMappings

类型:字符串

有效值:PATH | LOGICAL

必需:否

Policy

适用于您的用户的会话策略,以便您可以跨多个用户使用同一 Amazon Identity and Access Management (IAM) 角色。此策略将用户的访问权限缩小至 Amazon S3 存储桶的一部分。可在此策略中使用的变量包括 ${Transfer:UserName}${Transfer:HomeDirectory}${Transfer:HomeBucket}

类型:字符串

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

必需:否

PosixProfile

指定完整的 POSIX 身份,包括用户 ID (Uid)、组 ID (Gid) 和任何辅助组 ID (SecondaryGids),用于控制用户对 Amazon Elastic File System (Amazon EFS) 文件系统的访问。POSIX 权限针对文件系统中的文件和目录设置,用于确定用户在将文件传入和传出 Amazon EFS 文件系统时获得的访问权限级别。

类型:PosixProfile 对象

必需:否

Role

(IAM) 角色的亚马逊资源名称 (ARN),用于控制您的用户对您的 Amazon S3 存储桶或 Amazon EFS 文件系统的访问权限。 Amazon Identity and Access Management 附加到此角色的策略确定在将文件传入和传出 Amazon S3 桶或 Amazon EFS 文件系统时要为用户提供的访问权限级别。IAM 角色还应包含一个信任关系,从而允许服务器在为用户的传输请求提供服务时访问您的资源。

类型:字符串

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

模式:arn:.*role/\S+

必需:否

SshPublicKeys

指定为所述用户存储的 Secure Shell (SSH) 密钥的公有密钥部分。

类型:SshPublicKey 对象数组

数组成员:最少 0 个物品。最多 5 项。

必需:否

Tags

为请求的用户指定键值对。出于各种目的,标签可用于搜索和分组用户。

类型:Tag 对象数组

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

必需:否

UserName

指定请求描述的用户的名称。用户名用于身份验证。这是您的用户登录您的服务器时将使用的字符串。

类型:字符串

长度约束:最小长度为 3。最大长度为 100。

模式:[\w][\w@.-]{2,99}

必需:否

另请参阅

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