CreateUser

Erstellt einen Benutzer und ordnet ihn einem vorhandenen Server mit aktiviertem Dateiübertragungsprotokoll zu. Sie können nur Benutzer mit Servern anlegen und zuordnen, bei denen IdentityProviderType auf SERVICE_MANAGED gesetzt ist. Mithilfe von Parametern für CreateUser können Sie den Benutzernamen angeben, das Basisverzeichnis einrichten, den öffentlichen Schlüssel des Benutzers speichern und dem Benutzer die Rolle AWS Identity and Access Management (IAM) zuweisen. Optional können Sie auch eine Sitzungssrichtlinie hinzufügen und Metadaten Tags zuweisen, die zur Gruppierung und Suche von Benutzern verwendet werden.

Anforderungssyntax

{
   "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"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

HomeDirectory

Das Zielverzeichnis (Ordner) für einen Benutzer bei der Serveranmeldung mithilfe des Client.

Ein Beispiel für HomeDirectory ist /bucket_name/home/mydirectory.

Anmerkung

Der HomeDirectory-Parameter wird nur verwendet, wenn HomeDirectoryType auf PATH gesetzt ist.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.

Pattern: (|/.*)

Erforderlich: Nein

HomeDirectoryMappings

Logische Verzeichniszuordnungen, die angeben, welche Amazon S3- oder Amazon EFS-Pfade und -Schlüssel für Ihren Benutzer sichtbar sein sollen und wie Sie sie sichtbar machen möchten. Sie müssen das Entry Target Und-Paar angeben, das Entry zeigt, wie der Pfad sichtbar gemacht Target wird und der tatsächliche Amazon S3- oder Amazon EFS-Pfad ist. Wenn Sie nur ein Ziel angeben, wird es unverändert angezeigt. Sie müssen außerdem sicherstellen, dass Ihre AWS Identity and Access Management (IAM-) Rolle Zugriff auf Pfade in Target bietet. Dieser Wert kann nur gesetzt werden, wenn er auf LOGICAL gesetzt HomeDirectoryType ist.

Das Folgende ist ein Entry Beispiel für ein Target Und-Paar.

[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]

In den meisten Fällen können Sie diesen Wert anstelle der Sitzungsrichtlinie verwenden, um Ihren Benutzer auf das angegebene Home-Verzeichnis (“ chroot „) zu beschränken. Zu diesem Zweck können Sie den Wert Entry auf / und Target auf den Wert setzen, den der Benutzer bei der Anmeldung für sein Home-Verzeichnis sehen soll.

Im Folgenden finden Sie ein Entry Beispiel für ein Target Und-Paarchroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

Typ: Array von HomeDirectoryMapEntry-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Maximale Anzahl von 50000 Artikeln.

Erforderlich: Nein

HomeDirectoryType

Die Art des Zielverzeichnisses (Ordners), das das Home-Verzeichnis Ihrer Benutzer sein soll, wenn sie sich beim Server anmelden. Wenn Sie es auf einstellenPATH, sieht der Benutzer den absoluten Amazon S3-Bucket- oder Amazon EFS-Pfad so, wie er in seinen File Transfer Protocol-Clients ist. Wenn Sie es auf einstellenLOGICAL, müssen Sie Zuordnungen dafür angeben, wie Sie Amazon S3- oder Amazon EFS-Pfade HomeDirectoryMappings für Ihre Benutzer sichtbar machen möchten.

Anmerkung

HomeDirectoryTypeIst dies der LOGICAL Fall, müssen Sie mithilfe des Parameters Zuordnungen angeben. HomeDirectoryMappings Ist dies hingegen der Fall, HomeDirectoryType geben Sie mithilfe des Parameters einen absoluten Pfad anHomeDirectory. PATH Sie können nicht beides HomeDirectory und HomeDirectoryMappings in Ihrer Vorlage haben.

Typ: Zeichenfolge

Zulässige Werte: PATH | LOGICAL

Erforderlich: Nein

Policy

Eine Sitzungsrichtlinie für Ihren Benutzer, sodass Sie dieselbe AWS Identity and Access Management (IAM-) Rolle für mehrere Benutzer verwenden können. Diese Richtlinie beschränkt den Zugriff eines Benutzers auf Teile seines Amazon S3 S3-Buckets. Variablen, die Sie in dieser Richtlinie verwenden können: ${Transfer:UserName}, ${Transfer:HomeDirectory} und ${Transfer:HomeBucket}.

Anmerkung

Diese Richtlinie gilt nur, wenn die Domain von Amazon S3 ServerId ist. Amazon EFS verwendet keine Sitzungsrichtlinien.

AWS Transfer Family Speichert für Sitzungsrichtlinien die Richtlinie als JSON-Blob und nicht als Amazon-Ressourcennamen (ARN) der Richtlinie. Speichern Sie die Richtlinie als ein JSON-Blob und geben Sie sie in das Policy-Argument ein.

Ein Beispiel für eine Sitzungsrichtlinien finden Sie unter Sitzungsrichtlinien.

Weitere Informationen finden Sie AssumeRolein der AWS Security Token Service API-Referenz.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 2048 Zeichen.

Erforderlich: Nein

PosixProfile

Gibt die vollständige POSIX-Identität an, einschließlich Benutzer-ID (Uid), Gruppen-ID (Gid) und aller sekundären Gruppen-IDs (SecondaryGids), die den Zugriff Ihrer Benutzer auf Ihre Amazon EFS-Dateisysteme steuert. Die POSIX-Berechtigungen, die für Dateien und Verzeichnisse in Amazon EFS festgelegt sind, bestimmen die Zugriffsebene, die Ihre Benutzer erhalten, wenn sie Dateien in und aus Ihren Amazon EFS-Dateisystemen übertragen.

Typ: PosixProfile Objekt

Erforderlich: Nein

Role

Der Amazon-Ressourcenname (ARN) der Rolle AWS Identity and Access Management (IAM), die den Zugriff Ihrer Benutzer auf Ihren Amazon S3-Bucket oder Ihr Amazon EFS-Dateisystem steuert. Die mit dieser Rolle verbundenen Richtlinien bestimmen die Zugriffsebene, die Sie Ihren Benutzern beim Übertragen von Dateien in und aus Ihrem Amazon-S3-Bucket oder Amazon-EFS-Dateisystem bereitstellen möchten. Die IAM-Rolle sollte außerdem eine Vertrauensstellung enthalten, mit der der Server Zugriff auf Ihre Ressourcen erhält, wenn er die Übertragungsanfragen Ihres Benutzers bearbeitet.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 2048 Zeichen.

Pattern: arn:.*role/\S+

Erforderlich: Ja

ServerId

Eine vom System zugewiesene eindeutige ID für eine Server-Instance. Dies ist der spezifische Server, dem Sie Ihren Benutzer hinzugefügt haben.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: s-([0-9a-f]{17})

Erforderlich: Ja

SshPublicKeyBody

Der öffentliche Teil des Secure Shell (SSH) -Schlüssels, der zur Authentifizierung des Benutzers gegenüber dem Server verwendet wird.

Bei den drei Standardelementen im SSH-Format für öffentliche Schlüssel handelt es sich <key type> um ein optionales <comment> Element mit Leerzeichen zwischen den einzelnen Elementen. <body base64>

AWS Transfer Family akzeptiert RSA-, ECDSA- und ED25519-Schlüssel.

• Für RSA-Schlüssel ist der Schlüsseltyp. ssh-rsa

• Für ED25519-Schlüssel ist der Schlüsseltyp. ssh-ed25519

• Bei ECSA-Schlüsseln ist der Schlüsseltyp entweder, oder ecdsa-sha2-nistp256 ecdsa-sha2-nistp384ecdsa-sha2-nistp521, abhängig von der Größe des von Ihnen generierten Schlüssels.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 2048 Zeichen.

Erforderlich: Nein

Tags

Schlüssel-Wert-Paare, die zur Gruppierung und Suche von Benutzern verwendet werden können. Tags sind Benutzern angehängte Metadaten für einen bestimmten Zweck.

Typ: Array von Tag-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.

Erforderlich: Nein

UserName

Eine eindeutige Zeichenfolge, die einen Benutzer identifiziert und ServerId zugeordnet ist. Dieser Benutzername muss mindestens 3 und maximal 100 Zeichen enthalten. Folgende Zeichen sind gültig: a-z, A-Z, 0-9, Unterstrich '_', Bindestrich '-', Punkt '.'und beim Zeichen '@'. Der Benutzername kann nicht mit einem Bindestrich, einem Punkt oder einem At beginnen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 3. Maximale Länge beträgt 100 Zeichen.

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

Erforderlich: Ja

Antwortsyntax

{
   "ServerId": "string",
   "UserName": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

ServerId

Die ID des Servers, mit dem der Benutzer verbunden ist.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: s-([0-9a-f]{17})

UserName

Eine eindeutige Zeichenfolge, die einen Transfer Family Family-Benutzer identifiziert.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 3. Maximale Länge beträgt 100 Zeichen.

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

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTP Status Code: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTP Status Code: 400

ResourceExistsException

Die angeforderte Ressource ist nicht vorhanden oder befindet sich in einer anderen Region als der für den Befehl angegebenen.

HTTP Status Code: 400

ResourceNotFoundException

Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.

HTTP Status Code: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTP Status Code: 500

Beispiele

Beispiel

Um einen Benutzer zu erstellen, können Sie zunächst die Parameter beispielsweise createUserParameters in einer JSON-Datei speichern und dann den API-Befehl create-user ausführen.

{
    "HomeDirectory": "/DOC-EXAMPLE-BUCKET",
    "HomeDirectoryType": "PATH",
    "Role": "arn:aws:iam::111122223333:role/bob-role",
    "ServerId": "s-1111aaaa2222bbbb3",
    "SshPublicKeyBody": "ecdsa-sha2-nistp521 AAAAE2VjZHNhLXNoYTItbmlzdHA... [e-mail]",
    "UserName": "bobusa-API"
}

Beispielanforderung

aws transfer create-user --cli-input-json file://createUserParameters

Beispielantwort

{
    "ServerId": ""s-1111aaaa2222bbbb3",
    "UserName": "bobusa-API"
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden:

• AWS -Befehlszeilenschnittstelle

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK für JavaScript V3

• AWS SDK for PHP V3

• AWS SDK für Python

• AWS SDK for Ruby V3