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.
CreateServer
Instanziiert einen virtuellen Server mit automatischer Skalierung basierend auf dem ausgewählten Dateiübertragungs-Protokoll in AWS. Wenn Sie Ihren Dateiübertragungs-Protokoll-fähigen Server aktualisieren oder mit Benutzern arbeiten, verwenden Sie die vom Service generierte ServerId
-Eigenschaft, die dem neu erstellten Server zugewiesen ist.
Anforderungssyntax
{
"Certificate": "string
",
"Domain": "string
",
"EndpointDetails": {
"AddressAllocationIds": [ "string
" ],
"SecurityGroupIds": [ "string
" ],
"SubnetIds": [ "string
" ],
"VpcEndpointId": "string
",
"VpcId": "string
"
},
"EndpointType": "string
",
"HostKey": "string
",
"IdentityProviderDetails": {
"DirectoryId": "string
",
"Function": "string
",
"InvocationRole": "string
",
"SftpAuthenticationMethods": "string
",
"Url": "string
"
},
"IdentityProviderType": "string
",
"LoggingRole": "string
",
"PostAuthenticationLoginBanner": "string
",
"PreAuthenticationLoginBanner": "string
",
"ProtocolDetails": {
"As2Transports": [ "string
" ],
"PassiveIp": "string
",
"SetStatOption": "string
",
"TlsSessionResumptionMode": "string
"
},
"Protocols": [ "string
" ],
"S3StorageOptions": {
"DirectoryListingOptimization": "string
"
},
"SecurityPolicyName": "string
",
"StructuredLogDestinations": [ "string
" ],
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"WorkflowDetails": {
"OnPartialUpload": [
{
"ExecutionRole": "string
",
"WorkflowId": "string
"
}
],
"OnUpload": [
{
"ExecutionRole": "string
",
"WorkflowId": "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.
- Certificate
-
Der Amazon-Ressourcenname (ARN) des AWS Certificate Manager (ACM)-Zertifikats. Erforderlich, wenn
Protocols
aufFTPS
eingestellt ist.Informationen zum Anfordern eines neuen öffentlichen Zertifikats finden Sie unter Anfordern eines öffentlichen Zertifikats im AWS Certificate Manager Benutzerhandbuch.
Informationen zum Importieren eines vorhandenen Zertifikats in ACM finden Sie unter Zertifikate in ACM importieren im AWS Certificate Manager Benutzerhandbuch.
Informationen zum Anfordern eines privaten Zertifikats für die Verwendung von FTPS über private IP-Adressen finden Sie unter Anfordern eines privaten Zertifikats im AWS Certificate Manager Benutzerhandbuch.
Zertifikate mit den folgenden kryptografischen Algorithmen und Schlüsselgrößen werden unterstützt:
-
2048-Bit-RSA (RSA_2048)
-
4096-Bit-RSA (RSA_4096)
-
Elliptic Prime Curve 256-Bit (EC_prime256v1)
-
Elliptic Prime Curve 384-Bit (EC_secp384r1)
-
Elliptic Prime Curve 521-Bit (EC_secp521r1)
Anmerkung
Das Zertifikat muss ein gültiges SSL/TLS X.509 Version 3-Zertifikat mit FQDN oder IP-Adresse und Informationen über den Aussteller sein.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1600 Zeichen.
Erforderlich: Nein
-
- Domain
-
Die Domäne des Speichersystems, das für Dateiübertragungen verwendet wird. Es sind zwei Domänen verfügbar: Amazon Simple Storage Service (Amazon S3) und Amazon Elastic File System (Amazon EFS). Der Standardwert ist S3.
Anmerkung
Nachdem der Server erstellt wurde, kann die Domain nicht mehr geändert werden.
Typ: Zeichenfolge
Zulässige Werte:
S3 | EFS
Erforderlich: Nein
- EndpointDetails
-
Die Virtual Private Cloud (VPC)-Endpunkt-Einstellungen, die für Ihren Server konfiguriert sind. Wenn Sie Ihren Endpunkt in Ihrer VPC hosten, können Sie ihn nur für Ressourcen innerhalb Ihrer VPC zugänglich machen, oder Sie können elastische IP-Adressen anfügen und ihn für Clients über das Internet zugänglich machen. Die Standard-Sicherheitsgruppen Ihrer VPC werden Ihrem Endpunkt automatisch zugewiesen.
Typ: EndpointDetails Objekt
Erforderlich: Nein
- EndpointType
-
Der Typ des Endpunkts, den Ihr Server verwenden soll. Sie können den Endpunkt Ihres Servers öffentlich zugänglich machen (PUBLIC) oder ihn in Ihrer VPC hosten. Mit einem Endpunkt, der in einer VPC gehostet wird, können Sie den Zugriff auf Ihren Server und Ressourcen nur innerhalb Ihrer VPC einschränken oder sich für das Internet entscheiden, indem Sie Elastic-IP-Adressen direkt an ihn anfügen.
Anmerkung
Nach dem 19. Mai 2021 können Sie mit
EndpointType=VPC_ENDPOINT
Ihrem keinen Server mehr erstellen, AWS-Konto sofern Ihr Konto dies nicht bereits vor dem 19. Mai 2021 getan hat. Wenn du AWS-Konto am oder vor dem 19. Mai 2021 bereits Server mitEndpointType=VPC_ENDPOINT
in deinem erstellt hast, bist du davon nicht betroffen. Verwenden Sie nach diesem DatumEndpointType
=VPC
.Weitere Informationen finden Sie unter Einstellung der Verwendung von VPC_ENDPOINT.
Es wird empfohlen, dass Sie
VPC
alsEndpointType
verwenden. Bei diesem Endpunkttyp haben Sie die Möglichkeit, bis zu drei Elastic IPv4-Adressen (inklusive BYO IP) direkt mit dem Endpunkt Ihres Servers zu verknüpfen und VPC-Sicherheitsgruppen zu verwenden, um den Datenverkehr durch die öffentliche IP-Adresse des Clients zu beschränken. Dies ist nicht möglich, wennEndpointType
aufVPC_ENDPOINT
gesetzt ist.Typ: Zeichenfolge
Zulässige Werte:
PUBLIC | VPC | VPC_ENDPOINT
Erforderlich: Nein
- HostKey
-
Der private RSA-, ECDSA- oder ED25519-Schlüssel, der für Ihren SFTP-fähigen Server verwendet werden soll. Sie können mehrere Hostschlüssel hinzufügen, falls Sie Schlüssel rotieren möchten oder über einen Satz aktiver Schlüssel verfügen, die unterschiedliche Algorithmen verwenden.
Verwenden Sie den folgenden Befehl, um einen RSA 2048-Bit-Schlüssel ohne Passphrase zu generieren:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.Verwenden Sie einen Mindestwert von 2048 für die Option.
-b
Sie können einen stärkeren Schlüssel erstellen, indem Sie 3072 oder 4096 verwenden.Verwenden Sie den folgenden Befehl, um einen 256-Bit-ECDSA-Schlüssel ohne Passphrase zu generieren:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.Gültige Werte für die
-b
Option für ECDSA sind 256, 384 und 521.Verwenden Sie den folgenden Befehl, um einen ED25519-Schlüssel ohne Passphrase zu generieren:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.Alle diese Befehle können Sie durch eine Zeichenfolge Ihrer Wahl my-new-server-keyersetzen.
Wichtig
Wenn Sie nicht vorhaben, bestehende Benutzer von einem vorhandenen SFTP-fähigen Server auf einen neuen Server zu migrieren, aktualisieren Sie den Hostschlüssel nicht. Das versehentliche Ändern des Host-Schlüssels eines Servers kann zu Unterbrechungen führen.
Weitere Informationen finden Sie im Benutzerhandbuch unter Hostschlüssel für Ihren SFTP-fähigen Server aktualisieren. AWS Transfer Family
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 4096.
Erforderlich: Nein
- IdentityProviderDetails
-
Erforderlich, wenn auf
IdentityProviderType
oder gesetzt ist.AWS_DIRECTORY_SERVICE
AWS_LAMBDA
API_GATEWAY
Akzeptiert ein Array mit allen Informationen, die erforderlich sind, um ein Verzeichnis inAWS_DIRECTORY_SERVICE
zu verwenden oder eine vom Kunden bereitgestellte Authentifizierungs-API aufzurufen, einschließlich der API-Gateway-URL. Erforderlich, wennIdentityProviderType
aufSERVICE_MANAGED
gesetzt ist.Typ: IdentityProviderDetails Objekt
Erforderlich: Nein
- IdentityProviderType
-
Das Authentifizierungsverfahren für einen Server. Der Standardwert ist
SERVICE_MANAGED
, mit dem Sie Benutzeranmeldeinformationen innerhalb des AWS Transfer Family Dienstes speichern und darauf zugreifen können.Wird verwendet
AWS_DIRECTORY_SERVICE
, um Zugriff auf Active Directory-Gruppen in AWS Directory Service for Microsoft Active Directory oder Microsoft Active Directory in Ihrer lokalen Umgebung oder bei der AWS Verwendung von AD Connector bereitzustellen. Für diese Option ist es auch erforderlich, dass Sie mithilfe des ParametersIdentityProviderDetails
eine Directory-ID angeben.Verwenden Sie den
API_GATEWAY
-Wert für die Integration eines Identitätsanbieters Ihrer Wahl. DieAPI_GATEWAY
-Einstellung erfordert, dass Sie mithilfe des ParametersIdentityProviderDetails
die URL eines Amazon-API-Gateway-Endpunkts angeben, der zur Authentifizierung aufgerufen wird.Verwenden Sie den
AWS_LAMBDA
Wert, um eine AWS Lambda Funktion direkt als Identitätsanbieter zu verwenden. Wenn Sie diesen Wert wählen, müssen Sie den ARN für die Lambda-Funktion imFunction
Parameter für denIdentityProviderDetails
Datentyp angeben.Typ: Zeichenfolge
Zulässige Werte:
SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA
Erforderlich: Nein
- LoggingRole
-
Der Amazon-Ressourcenname (ARN) der AWS Identity and Access Management (IAM) -Rolle, der es einem Server ermöglicht, die CloudWatch Amazon-Protokollierung für Amazon S3 oder Amazon EFSEvents zu aktivieren. Wenn diese Option aktiviert ist, können Sie Benutzeraktivitäten in Ihren Protokollen einsehen. CloudWatch
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 2048 Zeichen.
Pattern:
(|arn:.*role/\S+)
Erforderlich: Nein
- PostAuthenticationLoginBanner
-
Gibt eine Zeichenfolge an, die angezeigt wird, wenn Benutzer sich mit einem Server verbinden. Diese Zeichenfolge wird nach Authentifizierung des Benutzers angezeigt.
Anmerkung
Das SFTP-Protokoll unterstützt keine Anzeige-Banner nach der Authentifizierung.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 4096.
Pattern:
[\x09-\x0D\x20-\x7E]*
Erforderlich: Nein
- PreAuthenticationLoginBanner
-
Gibt eine Zeichenfolge an, die angezeigt wird, wenn Benutzer sich mit einem Server verbinden. Diese Zeichenfolge wird angezeigt, bevor sich der Benutzer authentifiziert. Das folgende Banner zeigt beispielsweise Details zur Verwendung des Systems an:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge von 4096.
Pattern:
[\x09-\x0D\x20-\x7E]*
Erforderlich: Nein
- ProtocolDetails
-
Protokolleinstellungen, die für Ihren Server konfiguriert sind.
-
Verwenden Sie den Parameter
PassiveIp
zur Angabe des passiven Modus (für FTP- und FTPS-Protokolle). Geben Sie eine einzelne gepunktete IPv4-Adresse ein, z. B. die externe IP-Adresse einer Firewall, eines Routers oder eines Load Balancers. -
Verwenden Sie den Parameter
SetStatOption
, um den Fehler zu ignorieren, der generiert wird, wenn der Client versucht, den BefehlSETSTAT
für eine Datei zu verwenden, die Sie in einen Amazon-S3-Bucket hochladen. Damit der AWS Transfer Family Server denSETSTAT
Befehl ignoriert und Dateien hochlädt, ohne Änderungen an Ihrem SFTP-Client vornehmen zu müssen, setzen Sie den Wert auf.ENABLE_NO_OP
Wenn Sie denSetStatOption
Parameter auf setzenENABLE_NO_OP
, generiert Transfer Family einen Protokolleintrag in Amazon CloudWatch Logs, sodass Sie feststellen können, wann der Client einenSETSTAT
Anruf tätigt. -
Verwenden Sie den
TlsSessionResumptionMode
Parameter, um festzustellen, ob Ihr AWS Transfer Family Server die letzten, ausgehandelten Sitzungen über eine eindeutige Sitzungs-ID wieder aufnimmt. -
As2Transports
gibt an, wie AS2-Nachrichten transportiert werden sollen. Derzeit wird nur HTTP unterstützt.
Typ: ProtocolDetails Objekt
Erforderlich: Nein
-
- Protocols
-
Gibt das/die Dateiübertragungsprotokoll(e) an, über das/die der Dateiübertragungsprotokoll-Client eine Verbindung zum Endpunkt des Servers herstellen kann. Die verfügbaren Protokolle sind:
-
SFTP
(Secure Shell (SSH) File Transfer Protocol): Dateiübertragung über SSH -
FTPS
(File Transfer Protocol Secure): Dateiübertragung mit TLS-Verschlüsselung -
FTP
(File Transfer Protocol): Unverschlüsselte Dateiübertragung -
AS2
(Anwendbarkeitserklärung 2): Wird für den Transport strukturierter Daten verwendet business-to-business
Anmerkung
-
Wenn Sie wählen
FTPS
, müssen Sie ein in AWS Certificate Manager (ACM) gespeichertes Zertifikat wählen, das zur Identifizierung Ihres Servers verwendet wird, wenn Clients über FTPS eine Verbindung zu ihm herstellen. -
Wenn
Protocol
entwederFTP
oderFTPS
enthält, mussEndpointType
VPC
lauten undIdentityProviderType
mussAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
oderAPI_GATEWAY
lauten. -
Wenn
Protocol
FTP
enthält, könnenAddressAllocationIds
nicht zugeordnet werden. -
Wenn
Protocol
nur aufSFTP
gesetzt ist, kannEndpointType
aufPUBLIC
gesetzt werden undIdentityProviderType
kann auf einen der unterstützten Identitätstypen gesetzt werden:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
oderAPI_GATEWAY
. -
Wenn das
Protocol
AS2
enthält, dann muss derEndpointType
VPC
lauten und die Domain muss Amazon S3 sein.
Typ: Zeichenfolgen-Array
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Maximale Anzahl von 4 Elementen.
Zulässige Werte:
SFTP | FTP | FTPS | AS2
Erforderlich: Nein
-
- S3StorageOptions
-
Gibt an, ob die Leistung für Ihre Amazon S3 S3-Verzeichnisse optimiert ist oder nicht. Diese ist standardmäßig deaktiviert.
Standardmäßig haben Zuordnungen von Home-Verzeichnissen einen
TYPE
Wert von.DIRECTORY
Wenn Sie diese Option aktivieren, müssten Sie den Wert dann explizit auf setzenHomeDirectoryMapEntry
Type
,FILE
wenn eine Zuordnung ein Dateiziel haben soll.Typ: S3StorageOptions Objekt
Erforderlich: Nein
- SecurityPolicyName
-
Gibt den Namen der Sicherheitsrichtlinie für den Server an.
Typ: Zeichenfolge
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 100 Zeichen.
Pattern:
Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+
Erforderlich: Nein
- StructuredLogDestinations
-
Gibt die Protokollgruppen an, an die Ihre Serverprotokolle gesendet werden.
Um eine Protokollgruppe anzugeben, müssen Sie den ARN für eine bestehende Protokollgruppe angeben. In diesem Fall lautet das Format der Protokollgruppe wie folgt:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
Beispiel:
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
Wenn Sie zuvor eine Protokollgruppe für einen Server angegeben haben, können Sie diese löschen und somit die strukturierte Protokollierung deaktivieren, indem Sie in einem
update-server
Aufruf einen leeren Wert für diesen Parameter angeben. Beispielsweise:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
Typ: Zeichenfolge-Array
Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 1 Element.
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.
Pattern:
arn:\S+
Erforderlich: Nein
- Tags
-
Schlüssel-Wert-Paare, die zur Gruppierung und Suche von Servern verwendet werden können.
Typ: Array von Tag-Objekten
Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.
Erforderlich: Nein
- WorkflowDetails
-
Gibt die Workflow-ID für den zuzuweisenden Workflow und die für die Ausführung des Workflows verwendete Ausführungsrolle an.
Zusätzlich zu einem Workflow, der ausgeführt wird, wenn eine Datei vollständig hochgeladen wurde, kann
WorkflowDetails
auch eine Workflow-ID (und Ausführungsrolle) für einen Workflow enthalten, der beim teilweisen Upload ausgeführt werden soll. Ein teilweiser Upload erfolgt, wenn die Serversitzung unterbrochen wird, während die Datei noch hochgeladen wird.Typ: WorkflowDetails Objekt
Erforderlich: Nein
Antwortsyntax
{
"ServerId": "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 vom Dienst zugewiesene ID des Servers, der erstellt wird.
Typ: Zeichenfolge
Längenbeschränkungen: Feste Länge von 19.
Pattern:
s-([0-9a-f]{17})
Fehler
Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.
- AccessDeniedException
-
Sie haben keinen ausreichenden Zugriff zum Durchführen dieser Aktion.
HTTP Status Code: 400
- 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
- ThrottlingException
-
Die Anforderung wurde aufgrund der Drosselung von Anforderungen abgelehnt.
HTTP Status Code: 400
Beispiele
Beispiel
Im folgenden Beispiel wird ein neuer Server mit einem erstelltVPC_ENDPOINT
.
Beispielanforderung
{
"EndpointType": "VPC",
"EndpointDetails":...,
"HostKey": "Your RSA private key",
"IdentityProviderDetails": "IdentityProvider",
"IdentityProviderType": "SERVICE_MANAGED",
"LoggingRole": "CloudWatchLoggingRole",
"Tags": [
{
"Key": "Name",
"Value": "MyServer"
}
]
}
Beispiel
Dies ist eine Beispielantwort für diesen API-Aufruf.
Beispielantwort
{
"ServerId": "s-01234567890abcdef"
}
Weitere Informationen finden Sie unter:
Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: