翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateUser
ユーザーを作成し、既存のファイル転送プロトコル対応サーバーと関連付けます。IdentityProviderType が SERVICE_MANAGED に設定されたサーバーのみを作成し、ユーザーを関連付けることができます。のパラメータを使用してCreateUser、ユーザー名の指定、ホームディレクトリの設定、ユーザーのパブリックキーの保存、ユーザーの AWS Identity and Access Management (IAM) ロールの割り当てを行うことができます。オプションで、セッションポリシーの追加、ユーザーのグループ化や検索に使用できるタグがあるメタデータの割り当てが可能です。
リクエストの構文
{
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "string"
}
],
"HomeDirectoryType": "string",
"Policy": "string",
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Role": "string",
"ServerId": "string",
"SshPublicKeyBody": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserName": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- HomeDirectory
-
ユーザーがクライアントを使用してサーバーにログインするときの、ユーザーのランディングディレクトリ (フォルダ)。
HomeDirectoryの例は/bucket_name/home/mydirectoryです。注記
HomeDirectoryパラメータは、HomeDirectoryTypeがPATHに設定されている場合のみ使用されます。型: 文字列
長さの制限: 最小長は 0 です。最大長は 1,024 です。
パターン:
(|/.*)必須: いいえ
- HomeDirectoryMappings
-
ユーザーに表示する Amazon S3 または Amazon EFS のパスとキー、およびそれらをどのように表示するかを指定する論理ディレクトリマッピング。
EntryとTargetのペアを指定する必要があり、Entryはパスの表示方法を示し、Targetは実際の Amazon S3 または Amazon EFS のパスです。ターゲットを指定しただけの場合は、そのまま表示されます。また、 AWS Identity and Access Management (IAM) ロールが のパスへのアクセスを許可していることを確認する必要がありますTarget。この値は、HomeDirectoryTypeがLOGICALに設定されている場合にのみ設定できます。以下は
EntryとTargetのペアの例です。[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]ほとんどの場合、セッションポリシーの代わりにこの値を使用することで、指定されたホームディレクトリ (「
chroot」) にユーザーをロックダウンできます。これを行うには、Entryを/に設定し、Targetをユーザーがログインしたときに表示されるホームディレクトリの値に設定すればよいです。以下は、
chrootについてのEntryとTargetのペアの例です。[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]型: HomeDirectoryMapEntry オブジェクトの配列
配列メンバー：最小数は 1 項目です。最大数は 50,000 項目です。
必須：いいえ
- HomeDirectoryType
-
ユーザーがサーバーにログインするときにホームディレクトリにするランディングディレクトリ (フォルダ) のタイプ。これを
PATHに設定した場合、ユーザーには、ファイル転送プロトコルクライアントに、絶対的な Amazon S3 バケットまたは現状の Amazon EFS パスが表示されます。これをLOGICALに設定した場合、Amazon S3 または Amazon EFS パスをユーザーに表示する方法に関して、HomeDirectoryMappingsでマッピングを指定する必要があります。注記
HomeDirectoryTypeがLOGICALの場合は、HomeDirectoryMappingsパラメータを使用してマッピングを指定する必要があります。一方、HomeDirectoryTypeがPATHの場合は、HomeDirectoryパラメータを使用して絶対パスを指定します。テンプレートにHomeDirectoryとHomeDirectoryMappingsの両方を含めることはできません。型: 文字列
有効な値：
PATH | LOGICAL必須：いいえ
- Policy
-
複数のユーザーで同じ AWS Identity and Access Management (IAM) ロールを使用できるように、ユーザーのセッションポリシー。このポリシーは、ユーザーアクセスのスコープを Amazon S3 バケットの一部に絞り込みます。このポリシー内に使用できる変数には、
${Transfer:UserName}、${Transfer:HomeDirectory}、${Transfer:HomeBucket}があります。注記
このポリシーは、
ServerIdドメインが Amazon S3 の場合にのみ適用されます。Amazon EFS はセッション・ポリシーを使用しません。セッションポリシーの場合、 はポリシーの Amazon リソースネーム (ARN) ではなく、ポリシーを JSON BLOB として AWS Transfer Family 保存します。JSON blob としてポリシーを保存し、
Policy因数に渡します。セッションポリシーの例については、「セッションポリシーの例」を参照してください。
詳細については、 AWS 「 Security Token Service API リファレンスAssumeRole」の「」を参照してください。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 2048 です。
必須：いいえ
- PosixProfile
-
ユーザーの Amazon EFS ファイルシステムへのアクセスを制御する、ユーザー ID (
Uid)、グループ ID (Gid)、およびセカンダリグループ ID (SecondaryGids) を含む完全 POSIX ID を指定します。Amazon EFS 内のファイルとディレクトリに設定される 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 です。
Pattern:
arn:.*role/\S+必須：はい
- ServerId
-
サーバーインスタンスにシステムで割り当てられた一意の識別子。これはユーザーを追加したサーバーに固有です。
型: 文字列
長さの制限: 固定長は 19 です。
パターン：
s-([0-9a-f]{17})必須：はい
- SshPublicKeyBody
-
ユーザーをサーバーに認証する際に使用される Secure Shell (SSH) キーのパブリック部分。
SSH パブリックキーフォーマットの標準要素は
<key type>、<body base64>、そしてオプションの<comment>の 3 つで、各要素の間にスペースがあります。AWS Transfer Family は RSA、ECDSA、ED25519 キーを受け入れます。
-
RSA キーの場合、キータイプは
ssh-rsaです。 -
ED25519 キーの場合、キータイプは
ssh-ed25519です。 -
ECDSA キーの場合、キータイプは、生成したキーのサイズに応じて
ecdsa-sha2-nistp256、ecdsa-sha2-nistp384またはecdsa-sha2-nistp521のいずれかになります。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 2048 です。
必須：いいえ
-
- Tags
-
ユーザーのグループ化および検索に使用できるキーと値のペア。タグは、あらゆる目的でユーザーにアタッチされるメタデータです。
型: Tag オブジェクトの配列
配列メンバー：最小数は 1 項目です。最大数は 50 項目です。
必須：いいえ
- UserName
-
ユーザーを識別する一意の文字列であり、
ServerIdに関連付けられています。このユーザー名は、最小 3 文字、最大 100 文字にする必要があります。有効な文字は a～z、A～Z、0～9、アンダースコア (_)、ハイフン (-)、ピリオド (。)、アットマーク (@) です。ユーザー名をハイフン、ピリオド、アットマークで始めることはできません。型: 文字列
長さの制限: 最小長は 3 です。最大長は 100 です。
パターン:
[\w][\w@.-]{2,99}必須：はい
レスポンスの構文
{
"ServerId": "string",
"UserName": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceExistsException
-
要求されたリソースは存在しないか、コマンドに指定されたリージョン以外のリージョンに存在します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
例
例
ユーザを作成するには、まずパラメータを createUserParameters などの JSON ファイルに保存してから、create-user API コマンドを実行します。
{ "HomeDirectory": "/DOC-EXAMPLE-BUCKET", "HomeDirectoryType": "PATH", "Role": "arn:aws:iam::111122223333:role/bob-role", "ServerId": "s-1111aaaa2222bbbb3", "SshPublicKeyBody": "ecdsa-sha2-nistp521 AAAAE2VjZHNhLXNoYTItbmlzdHA... bobusa@mycomputer.us-east-1.amazon.com", "UserName": "bobusa-API" }
リクエスト例
aws transfer create-user --cli-input-json file://createUserParametersレスポンス例
{
"ServerId": ""s-1111aaaa2222bbbb3",
"UserName": "bobusa-API"
}以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
