DescribedUser - AWS Transfer Family

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribedUser

描述指定的使用者屬性。

目錄

Arn

為請求描述的使用者指定唯一的 Amazon Resource Name (ARN)。

類型:字串

長度限制︰長度下限為 20。長度上限為 1600。

模式:arn:\S+

必要:是

HomeDirectory

使用者使用其用戶端登入伺服器時的登陸目錄 (資料夾)。

HomeDirectory 範例為 /bucket_name/home/mydirectory

注意

只有在 HomeDirectoryType 設為 PATH 時才會使用 HomeDirectory 參數。

類型:字串

長度限制:長度下限為 0。長度上限為 1024。

模式:(|/.*)

必要:否

HomeDirectoryMappings

邏輯目錄映射,可指定使用者應看到哪些 Amazon S3 或 Amazon EFS 路徑和金鑰,以及您希望如何使其可見。您必須指定 EntryTarget對,其中 Entry顯示如何顯示路徑,並且Target是實際的 Amazon S3 或 Amazon EFS 路徑。如果您只指定目標,則會顯示為原樣。您也必須確保 AWS Identity and Access Management (IAM) 角色提供對 中路徑的存取權Target。只有在 設定為 時,才能HomeDirectoryType設定此值LOGICAL

在大多數情況下,您可以使用此值來取代工作階段政策,將使用者鎖定至指定的主目錄 ("chroot")。若要這麼做,您可以將 Entry設定為 '/' 並Target設定為 HomeDirectory 參數值。

類型:HomeDirectoryMapEntry 物件陣列

陣列成員:項目數下限為 1。最多 50000 個項目。

必要:否

HomeDirectoryType

使用者登入伺服器時,您希望的使用者主目錄之登陸目錄 (資料夾) 類型。如果您將其設定為 PATH,則使用者會看到絕對 Amazon S3 儲存貯體或 Amazon EFS 路徑,就像在其檔案傳輸通訊協定用戶端一樣。如果您將其設定為 LOGICAL,則需要在 中提供映射,HomeDirectoryMappings以了解如何讓使用者看見 Amazon S3 或 Amazon EFS 路徑。

注意

如果 HomeDirectoryTypeLOGICAL,您必須使用 HomeDirectoryMappings 參數提供映射。另一方面,如果 HomeDirectoryTypePATH,則您使用 HomeDirectory 參數提供絕對路徑。您無法在範本HomeDirectoryMappings中同時擁有 HomeDirectory和 。

類型:字串

有效值:PATH | LOGICAL

必要:否

Policy

適用於使用者的工作階段政策,讓您可以在多個使用者之間使用相同的 AWS Identity and Access Management (IAM) 角色。此政策會減少使用者對其 Amazon S3 儲存貯體部分存取權的範圍。您可以在此政策內使用的變數包括 ${Transfer:UserName}${Transfer:HomeDirectory}${Transfer:HomeBucket}

類型:字串

長度限制:長度下限為 0。長度上限為 2048。

必要:否

PosixProfile

指定完整POSIX身分,包括使用者 ID (Uid)、群組 ID IDs(Gid) 和任何次要群組 (SecondaryGids),以控制使用者對 Amazon Elastic File System (Amazon EFS) 檔案系統的存取。在檔案系統中的檔案和目錄上設定的POSIX許可決定了使用者在將檔案移入和移出 Amazon EFS 檔案系統時獲得的存取層級。

類型:PosixProfile 物件

必要:否

Role

(ARN) 角色的 Amazon Resource Name AWS Identity and Access Management (IAM),可控制使用者對 Amazon S3 儲存貯體或 Amazon EFS 檔案系統的存取。附加至此角色的政策會決定在將檔案移入和移出 Amazon S3 儲存貯體或 Amazon EFS 檔案系統時,您要為使用者提供的存取層級。此IAM角色也應包含信任關係,允許伺服器在服務使用者的傳輸請求時存取您的資源。

類型:字串

長度限制︰長度下限為 20。長度上限為 2048。

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

必要:否

SshPublicKeys

指定為描述的使用者存放的安全 Shell (SSH) 金鑰的公有金鑰部分。

類型:SshPublicKey 物件陣列

陣列成員:項目數下限為 0。項目數上限為 5。

必要:否

Tags

指定所請求使用者的鍵值對。標籤可用於搜尋和分組各種用途的使用者。

類型:Tag 物件陣列

陣列成員:項目數下限為 1。項目數上限為 50。

必要:否

UserName

指定請求描述的使用者名稱。使用者名稱用於身分驗證目的。這是使用者登入伺服器時將使用的字串。

類型:字串

長度限制:長度下限為 3。長度上限為 100。

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

必要:否

另請參閱

如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: