DescribedServer - AWS Transfer Family
InhaltWeitere 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.

DescribedServer

Beschreibt die Eigenschaften eines angegebenen Servers mit aktiviertem Dateiübertragungsprotokoll.

Inhalt

Arn

Gibt den eindeutigen Amazon-Ressourcennamen (ARN) des Servers an.

Typ: Zeichenfolge

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

Pattern: arn:\S+

Erforderlich: Ja

As2ServiceManagedEgressIpAddresses

Die Liste der Ausgangs-IP-Adressen dieses Servers. Diese IP-Adressen sind nur für Server relevant, die das AS2 Protokoll verwenden. Sie werden für das asynchrone MDNs Senden verwendet.

Diese IP-Adressen werden automatisch zugewiesen, wenn Sie einen AS2 Server erstellen. Wenn Sie einen vorhandenen Server aktualisieren und das AS2 Protokoll hinzufügen, werden außerdem statische IP-Adressen zugewiesen.

Typ: Zeichenfolgen-Array

Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

Erforderlich: Nein

Certificate

Gibt das AWS Zertifikat ARN des Certificate Manager (ACM) an. Erforderlich, wenn Protocols auf FTPS eingestellt ist.

Typ: Zeichenfolge

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

Erforderlich: Nein

Domain

Gibt die Domain des Speichersystems an, das für Dateiübertragungen verwendet wird.

Typ: Zeichenfolge

Zulässige Werte: S3 | EFS

Erforderlich: Nein

EndpointDetails

Die Virtual Private Cloud (VPC) -Endpunkteinstellungen, die für Ihren Server konfiguriert sind. Wenn Sie Ihren Endpunkt in Ihrem hostenVPC, können Sie Ihren Endpunkt nur für Ressourcen innerhalb Ihres Computers zugänglich machenVPC, oder Sie können Elastic IP-Adressen anhängen und Ihren Endpunkt für Clients über das Internet zugänglich machen. Ihre VPC Standard-Sicherheitsgruppen werden Ihrem Endpunkt automatisch zugewiesen.

Typ: EndpointDetails Objekt

Erforderlich: Nein

EndpointType

Definiert den Endpunkttyp, mit dem Ihr Server verbunden ist. Wenn Ihr Server mit einem VPC Endpunkt verbunden ist, ist Ihr Server nicht über das öffentliche Internet zugänglich.

Typ: Zeichenfolge

Zulässige Werte: PUBLIC | VPC | VPC_ENDPOINT

Erforderlich: Nein

HostKeyFingerprint

Gibt den Base64-codierten SHA256 Fingerabdruck des Hostschlüssels des Servers an. Dieser Wert entspricht der Ausgabe des Befehls. ssh-keygen -l -f my-new-server-key

Typ: Zeichenfolge

Erforderlich: Nein

IdentityProviderDetails

Gibt Informationen zum Aufrufen einer vom Kunden bereitgestellten Authentifizierung API an. Dieses Feld wird nicht gefüllt, wenn IdentityProviderType der eines Servers AWS_DIRECTORY_SERVICE oder SERVICE_MANAGED ist.

Typ: IdentityProviderDetails Objekt

Erforderlich: Nein

IdentityProviderType

Das Authentifizierungsverfahren für einen Server. Der Standardwert istSERVICE_MANAGED, der es Ihnen ermöglicht, Benutzeranmeldeinformationen innerhalb des AWS Transfer Family Dienstes zu speichern und darauf zuzugreifen.

Wird verwendetAWS_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 Parameters IdentityProviderDetails eine Directory-ID angeben.

Verwenden Sie den API_GATEWAY-Wert für die Integration eines Identitätsanbieters Ihrer Wahl. Für die API_GATEWAY Einstellung müssen Sie einen Amazon API Gateway-Endpunkt angebenURL, um mithilfe des IdentityProviderDetails Parameters eine Authentifizierung aufzurufen.

Verwenden Sie den AWS_LAMBDA Wert, um eine AWS Lambda Funktion direkt als Ihren Identitätsanbieter zu verwenden. Wenn Sie diesen Wert wählen, müssen Sie den ARN für die Lambda-Funktion im Function Parameter für den IdentityProviderDetails Datentyp angeben.

Typ: Zeichenfolge

Zulässige Werte: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

Erforderlich: Nein

LoggingRole

Der Amazon-Ressourcenname (ARN) der Rolle AWS Identity and Access Management (IAM), der es einem Server ermöglicht, die CloudWatch Amazon-Protokollierung für Amazon S3 oder Amazon zu aktivierenEFSevents. Wenn diese Option aktiviert ist, können Sie Benutzeraktivitäten in Ihren CloudWatch Protokollen einsehen.

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 von Bannern 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 PassiveIp Parameter, um den passiven Modus (für FTP und FTPS Protokolle) anzugeben. Geben Sie eine einzelne IPv4 Adresse mit vier Punkten 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 Befehl SETSTAT für eine Datei zu verwenden, die Sie in einen Amazon-S3-Bucket hochladen. Damit der AWS Transfer Family Server den SETSTAT 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 den SetStatOption Parameter auf setzenENABLE_NO_OP, generiert Transfer Family einen Protokolleintrag in Amazon CloudWatch Logs, sodass Sie feststellen können, wann der Client einen SETSTAT 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.

  • As2Transportsgibt die Transportmethode für die AS2 Nachrichten an. 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 business-to-business Daten verwendet

Anmerkung

  • Wenn Sie auswählenFTPS, müssen Sie ein in AWS Certificate Manager (ACM) gespeichertes Zertifikat auswählen, das zur Identifizierung Ihres Servers verwendet wird, wenn Clients eine Verbindung zu ihm herstellen. FTPS

  • Wenn Protocol entweder FTP oder FTPS enthält, muss EndpointType VPC lauten und IdentityProviderType muss AWS_DIRECTORY_SERVICE, AWS_LAMBDA oder API_GATEWAY lauten.

  • Wenn Protocol FTP enthält, können AddressAllocationIds nicht zugeordnet werden.

  • Wenn Protocol nur auf SFTP gesetzt ist, kann EndpointType auf PUBLIC gesetzt werden und IdentityProviderType kann auf einen der unterstützten Identitätstypen gesetzt werden: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA oder API_GATEWAY.

  • Wenn das Protocol AS2 enthält, dann muss der EndpointType 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 setzen HomeDirectoryMapEntryType, FILE wenn eine Zuordnung ein Dateiziel haben soll.

Typ: S3StorageOptions Objekt

Erforderlich: Nein

SecurityPolicyName

Gibt den Namen der Sicherheitsrichtlinie an, die dem Server zugewiesen ist.

Typ: Zeichenfolge

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

Pattern: TransferSecurityPolicy-.+

Erforderlich: Nein

ServerId

Gibt den eindeutigen, vom System zugewiesenen Bezeichner für einen Server an, den Sie instanziieren.

Typ: Zeichenfolge

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

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

Erforderlich: Nein

State

Der Zustand des Servers, der beschrieben wurde. Der Wert von ONLINE gibt an, dass der Server Aufträge annehmen und Dateien übertragen kann. StateDer Wert von OFFLINE bedeutet, dass der Server keine Dateiübertragungsvorgänge ausführen kann.

Der Status von STARTING und STOPPING gibt an, dass sich der Server in einem Zwischenzustand befindet, entweder nicht vollständig antworten kann oder nicht vollständig offline ist. Die Werte von START_FAILED oder STOP_FAILED können auf einen Fehler hinweisen.

Typ: Zeichenfolge

Zulässige Werte: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

Erforderlich: Nein

StructuredLogDestinations

Gibt die Protokollgruppen an, an die Ihre Serverprotokolle gesendet werden.

Um eine Protokollgruppe anzugeben, müssen Sie die 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

Gibt die Schlüssel-Wert-Paare an, mit denen Sie nach Servern suchen und diese gruppieren können, die dem beschriebenen Server zugewiesen wurden.

Typ: Array von Tag-Objekten

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

Erforderlich: Nein

UserCount

Gibt die Anzahl der Benutzer an, die einem Server zugewiesen sind, den Sie mit dem angegeben haben. ServerId

Typ: Ganzzahl

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

Weitere Informationen finden Sie unter:

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