ListedUser - AWS Transfer Family

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListedUser

指定するユーザーのプロパティを返します。

内容

Arn

知りたいユーザーの一意の Amazon リソースネーム (ARN) を指定します。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 1600 です。

Pattern: arn:\S+

必須:はい

HomeDirectory

ユーザーがクライアントを使用してサーバーにログインするときの、ユーザーのランディングディレクトリ (フォルダ)。

HomeDirectory の例は /bucket_name/home/mydirectory です。

注記

HomeDirectory パラメータは、HomeDirectoryTypePATH に設定されている場合のみ使用されます。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 1,024 です。

パターン: (|/.*)

必須: いいえ

HomeDirectoryType

ユーザーがサーバーにログインするときにホームディレクトリにするランディングディレクトリ (フォルダ) のタイプ。これを PATH に設定した場合、ユーザーには、ファイル転送プロトコルクライアントに、絶対的な Amazon S3 バケットまたは現状の Amazon EFS パスが表示されます。これを LOGICAL に設定した場合、Amazon S3 または Amazon EFS パスをユーザーに表示する方法に関して、HomeDirectoryMappings でマッピングを指定する必要があります。

注記

HomeDirectoryTypeLOGICAL の場合は、HomeDirectoryMappings パラメータを使用してマッピングを指定する必要があります。一方、HomeDirectoryTypePATH の場合は、HomeDirectory パラメータを使用して絶対パスを指定します。テンプレートに HomeDirectoryHomeDirectoryMappings の両方を含めることはできません。

型: 文字列

有効な値:PATH | LOGICAL

必須:いいえ

Role

Amazon S3 バケットまたは Amazon EFS ファイルシステムへのユーザーのアクセスを制御する AWS Identity and Access Management IAM ロールの Amazon リソースネーム (ARN) を指定します。このロールにアタッチされたポリシーにより、ファイルを Amazon S3 バケットまたは Amazon EFS ファイルシステム間で転送する際の、ユーザーに付与するアクセスレベルが決定されます。IAM ロールには、ユーザーの転送リクエストを処理する際に、サーバーによるリソースへのアクセスを許可する信頼関係も含まれる必要があります。

注記

Domain=S3 を持つサーバー用の Amazon S3 バケットまたは Domain=EFS を持つサーバー用の EFS ファイルシステムへのユーザーのアクセスを制御する IAM ロール、。

このロールにアタッチされたポリシーにより、ファイルを S3 バケットまたは EFS ファイルシステム間で転送する際の、ユーザーに付与するアクセスのレベルが決定されます。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 2,048 です。

パターン: arn:.*role/\S+

必須: いいえ

SshPublicKeyCount

指定したユーザー用に保存される SSH 公開キーの数を指定します。

型: 整数

必須: いいえ

UserName

ARN が指定されているユーザーの名前を指定します。ユーザー名は、認証の目的で使用されます。

型: 文字列

長さの制限: 最小長は 3 です。最大長は 100 です。

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

必須: いいえ

その他の参照資料

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。