DescribedUser - AWS Transfer Family

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

DescribedUser

指定されたユーザーのプロパティについて記述します。

内容

Arn

記述を要求されたユーザーの一意の Amazon リソースネーム (ARN) を指定します。

型: 文字列

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

Pattern: arn:\S+

必須:はい

HomeDirectory

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

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

注記

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

型: 文字列

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

パターン: (|/.*)

必須: いいえ

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 項目です。最大数は 50,000 項目です。

必須: いいえ

HomeDirectoryType

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

注記

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

型: 文字列

有効な値:PATH | LOGICAL

必須:いいえ

Policy

複数のユーザーに同じ AWS Identity and Access Management IAM ロールの使用を可能にするユーザーのセッションポリシー。このポリシーは、ユーザーアクセスのスコープを Amazon S3 バケットの一部に絞り込みます。このポリシー内に使用できる変数には、${Transfer:UserName}${Transfer:HomeDirectory}${Transfer:HomeBucket} があります。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 2048 です。

必須: いいえ

PosixProfile

Amazon Elastic File System (Amazon EFS) ファイルシステムへのユーザーのアクセスを制御する、ユーザー ID (Uid)、グループ ID (Gid)、およびセカンダリグループ ID (SecondaryGids) を含む、完全な POSIX ID を指定します。ファイルシステム内のファイルとディレクトリに設定される POSIX アクセス許可によって、Amazon EFS ファイルシステムとの間でファイルを転送するときにユーザーが得るアクセスのレベルが決まります。

型: PosixProfile オブジェクト

必須: いいえ

Role

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

型: 文字列

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

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

必須: いいえ

SshPublicKeys

記述されたユーザー用に保存された Secure Shell (SSH) のパブリックキー部分を指定します。

タイプ:SshPublicKey オブジェクトの配列

配列メンバー:最小数は 0 項目です。最大数は 5 項目です。

必須: いいえ

Tags

リクエストされたユーザーのキーバリューペアを指定します。タグは、さまざまな目的でユーザーを検索やグループ化する際に使用できます。

型: Tag オブジェクトの配列

配列メンバー:最小数は 1 項目です。最大数は 50 項目です。

必須: いいえ

UserName

記述をリクエストされたユーザーの名前を指定します。ユーザー名は、認証の目的で使用されます。これは、ユーザーがサーバーにログインするときに使用される文字列です。

型: 文字列

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

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

必須: いいえ

その他の参照資料

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