CreateLocationSmb - AWS DataSync
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

CreateLocationSmb

Erstellt einen Übertragungsort für einen SMB-Dateiserver (Server Message Block). AWS DataSync kann diesen Speicherort als Quelle oder Ziel für die Übertragung von Daten verwenden.

Bevor Sie beginnen, stellen Sie sicher, dass Sie wissen, wie auf SMB-Dateiserver DataSync zugegriffen wird. Weitere Informationen finden Sie unter Bereitstellen des DataSync Zugriffs auf SMB-Dateiserver.

Anforderungssyntax

{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "Password": "string",
   "ServerHostname": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "User": "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.

AgentArns

Gibt den DataSync Agenten (oder die Agenten) an, der eine Verbindung zu Ihrem SMB-Dateiserver herstellen kann. Sie geben einen Agenten anhand seines Amazon-Ressourcennamens (ARN) an.

Typ: Zeichenfolgen-Array

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

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Erforderlich: Ja

AuthenticationType

Gibt das Authentifizierungsprotokoll an, das für die Verbindung mit Ihrem SMB-Dateiserver DataSync verwendet wird. DataSync unterstützt NTLM (Standard) und KERBEROS Authentifizierung.

Weitere Informationen finden Sie unter Bereitstellen des DataSync Zugriffs auf SMB-Dateiserver.

Typ: Zeichenfolge

Zulässige Werte: NTLM | KERBEROS

Erforderlich: Nein

CmkSecretConfig

Gibt Konfigurationsinformationen für ein DataSync verwaltetes Geheimnis an, entweder ein Password oder KerberosKeytab (für NTLM (Standard-) bzw. KERBEROS Authentifizierungstypen), das für den Zugriff auf einen bestimmten SMB-Speicherort mit einem vom Kunden verwalteten SMB-Speicherort DataSync verwendet wird. AWS KMS key

Wenn Sie diesen Parameter als Teil einer CreateLocationSmbRequest Anfrage angeben, geben Sie nur den KMS-Schlüssel ARN an. DataSync verwendet diesen KMS-Schlüssel zusammen mit dem Password oder, den KerberosKeytab Sie angeben, um ein DataSync verwaltetes Geheimnis zum Speichern der Standortzugriffsanmeldeinformationen zu erstellen.

Stellen Sie sicher, dass dieser Benutzer berechtigt DataSync ist, auf den von Ihnen angegebenen KMS-Schlüssel zuzugreifen.

Anmerkung

Sie können entweder CmkSecretConfig (mit entweder Password oderKerberosKeytab) oder CustomSecretConfig (ohne Password undKerberosKeytab) verwenden, um Anmeldeinformationen für eine CreateLocationSmbRequest Anfrage anzugeben. Geben Sie nicht CmkSecretConfig sowohl als auch CustomSecretConfig Parameter für dieselbe Anfrage an.

Typ: CmkSecretConfig Objekt

Erforderlich: Nein

CustomSecretConfig

Gibt Konfigurationsinformationen für einen vom Kunden verwalteten Secrets Manager Secret an, bei dem die Anmeldeinformationen für den SMB-Speicherort in Secrets Manager als Klartext (fürPassword) oder binär (fürKerberosKeytab) gespeichert werden. Diese Konfiguration umfasst den geheimen ARN und den ARN für eine IAM-Rolle, die Zugriff auf den geheimen Schlüssel ermöglicht.

Anmerkung

Sie können entweder CmkSecretConfig (mitSasConfiguration) oder CustomSecretConfig (ohneSasConfiguration) Anmeldeinformationen für eine CreateLocationSmbRequest Anfrage angeben. Geben Sie nicht beide Parameter für dieselbe Anfrage an.

Typ: CustomSecretConfig Objekt

Erforderlich: Nein

DnsIpAddresses

Gibt die IPv6 Adressen IPv4 oder für die DNS-Server an, zu denen Ihr SMB-Dateiserver gehört. Dieser Parameter gilt nur, wenn er auf KERBEROS gesetzt AuthenticationType ist.

Wenn Sie mehrere Domänen in Ihrer Umgebung haben, wird durch die Konfiguration dieses Parameters sichergestellt, dass DataSync eine Verbindung zum richtigen SMB-Dateiserver hergestellt wird.

Typ: Zeichenfolgen-Array

Array-Mitglieder: Maximale Anzahl von 2 Elementen.

Längenbeschränkungen: Minimale Länge beträgt 7 Zeichen. Die maximale Länge beträgt 39.

Pattern: \A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z

Erforderlich: Nein

Domain

Gibt den Windows-Domain-Namen an, zu dem SMB-Dateiserver gehört. Dieser Parameter gilt nur, wenn er auf gesetzt AuthenticationType istNTLM.

Wenn Sie mehrere Domänen in Ihrer Umgebung haben, wird durch die Konfiguration dieses Parameters sichergestellt, dass DataSync eine Verbindung zum richtigen Dateiserver hergestellt wird.

Typ: Zeichenfolge

Längenbeschränkungen: Die maximale Länge beträgt 253.

Pattern: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

Erforderlich: Nein

KerberosKeytab

Gibt Ihre Kerberos-Schlüsseltabellendatei (Keytab) an, die Zuordnungen zwischen Ihrem Kerberos-Prinzipal und den Verschlüsselungsschlüsseln enthält.

Um Fehler bei der Ausführung von Aufgaben zu vermeiden, stellen Sie sicher, dass der Kerberos-Prinzipal, den Sie zum Erstellen der Keytab-Datei verwenden, genau dem entspricht, wofür Sie es angegeben haben. KerberosPrincipal

Typ: Base64-kodiertes Binärdatenobjekt

Längenbeschränkungen: Die maximale Länge beträgt 65536.

Erforderlich: Nein

KerberosKrb5Conf

Gibt eine Kerberos-Konfigurationsdatei (krb5.conf) an, die Ihre Kerberos-Realm-Konfiguration definiert.

Die Datei muss base64-codiert sein. Wenn Sie das verwenden AWS CLI, ist die Kodierung für Sie erledigt.

Typ: Base64-kodiertes Binärdatenobjekt

Längenbeschränkungen: Die maximale Länge beträgt 131072.

Erforderlich: Nein

KerberosPrincipal

Gibt einen Kerberos-Prinzipal an. Dabei handelt es sich um eine Identität in Ihrem Kerberos-Bereich, die berechtigt ist, auf die Dateien, Ordner und Dateimetadaten auf Ihrem SMB-Dateiserver zuzugreifen.

Ein Kerberos-Prinzipal könnte wie folgt aussehen. HOST/kerberosuser@MYDOMAIN.ORG

Bei Prinzipalnamen wird Groß- und Kleinschreibung beachtet. Ihre DataSync Aufgabenausführung schlägt fehl, wenn der Prinzipal, den Sie für diesen Parameter angeben, nicht exakt dem Prinzipal entspricht, den Sie zum Erstellen der Keytab-Datei verwenden.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

Pattern: ^.+$

Erforderlich: Nein

MountOptions

Gibt die Version des SMB-Protokolls an, das für den Zugriff auf Ihren SMB-Dateiserver DataSync verwendet wird.

Typ: SmbMountOptions Objekt

Erforderlich: Nein

Password

Gibt das Kennwort des Benutzers an, der Ihren SMB-Dateiserver bereitstellen kann und über Zugriffsrechte auf die Dateien und Ordner verfügt, die an Ihrer Übertragung beteiligt sind. Dieser Parameter gilt nur, wenn er auf NTLM gesetzt AuthenticationType ist.

Typ: Zeichenfolge

Längenbeschränkungen: Die maximale Länge beträgt 104.

Pattern: ^.{0,104}$

Erforderlich: Nein

ServerHostname

Gibt den Domänennamen oder die IP-Adresse (IPv4 oder IPv6) des SMB-Dateiservers an, mit dem Ihr DataSync Agent eine Verbindung herstellt.

Anmerkung

Wenn Sie die Kerberos-Authentifizierung verwenden, müssen Sie einen Domänennamen angeben.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 255.

Pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

Erforderlich: Ja

Subdirectory

Gibt den Namen der von Ihrem SMB-Dateiserver exportierten Freigabe an, auf der Daten gelesen oder geschrieben DataSync werden. Sie können ein Unterverzeichnis in den Freigabepfad aufnehmen (z. B./path/to/subdirectory). Stellen Sie sicher, dass andere SMB-Clients in Ihrem Netzwerk diesen Pfad ebenfalls bereitstellen können.

Um alle Daten im Unterverzeichnis zu kopieren, DataSync müssen Sie in der Lage sein, die SMB-Freigabe zu mounten und auf alle zugehörigen Daten zuzugreifen. Weitere Informationen finden Sie unter DataSync Zugriff auf SMB-Dateiserver bereitstellen.

Typ: Zeichenfolge

Längenbeschränkungen: Die maximale Länge beträgt 4096.

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

Erforderlich: Ja

Tags

Gibt Bezeichnungen an, mit denen Sie Ihre AWS -Ressourcen kategorisieren, filtern und suchen können. Wir empfehlen, zumindest ein Namensschild für Ihren Standort zu erstellen.

Typ: Array von TagListEntry-Objekten

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

Erforderlich: Nein

User

Gibt den Benutzer an, der die Dateien, Ordner und Dateimetadaten auf Ihrem SMB-Dateiserver bereitstellen und darauf zugreifen kann. Dieser Parameter gilt nur, wenn er auf NTLM gesetzt AuthenticationType ist.

Informationen zur Auswahl eines Benutzers mit der richtigen Zugriffsebene für Ihre Übertragung finden Sie unter DataSync Zugriff auf SMB-Dateiserver bereitstellen.

Typ: Zeichenfolge

Längenbeschränkungen: Die maximale Länge beträgt 104.

Pattern: ^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

Erforderlich: Nein

Antwortsyntax

{
   "LocationArn": "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.

LocationArn

Der ARN des SMB-Standorts, den Sie erstellt haben.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Fehler

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

InternalException

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP-Statuscode: 400

Beispiele

Beispielanforderung

Im folgenden Beispiel wird ein Speicherort für einen SMB-Dateiserver erstellt.

{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3"
   ],
   "Domain":"AMAZON",
   "MountOptions":{
      "Version":"SMB3"
   },
   "Password":"string",
   "ServerHostname":"MyServer.amazon.com",
   "Subdirectory":"share",
   "Tags":[
      {
         "Key":"department",
         "Value":"finance"
      }
   ],
   "User":"user-1"
}

Beispielantwort

Eine Antwort gibt den Standort-ARN Ihres SMB-Dateiservers zurück.

{
    "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}

Weitere Informationen finden Sie unter:

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