DescribedServer - AWS Transfer Family
Table des matièresconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

DescribedServer

Décrit les propriétés d'un serveur compatible avec le protocole de transfert de fichiers spécifié.

Table des matières

Arn

Spécifie le nom de ressource Amazon unique (ARN) du serveur.

Type : String

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.

Modèle : arn:\S+

Obligatoire : oui

As2ServiceManagedEgressIpAddresses

La liste des adresses IP de sortie de ce serveur. Ces adresses IP ne sont pertinentes que pour les serveurs qui utilisent le AS2 protocole. Ils sont utilisés pour l'envoi asynchroneMDNs.

Ces adresses IP sont attribuées automatiquement lorsque vous créez un AS2 serveur. En outre, si vous mettez à jour un serveur existant et ajoutez le AS2 protocole, des adresses IP statiques sont également attribuées.

Type : tableau de chaînes

Modèle : \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

Obligatoire : non

Certificate

Spécifie ARN le AWS certificat Certificate Manager (ACM). Obligatoire lorsque Protocols est défini sur FTPS.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximale de 1600.

Obligatoire : non

Domain

Spécifie le domaine du système de stockage utilisé pour les transferts de fichiers.

Type : String

Valeurs valides : S3 | EFS

Obligatoire : non

EndpointDetails

Les paramètres de point de terminaison du cloud privé virtuel (VPC) configurés pour votre serveur. Lorsque vous hébergez votre point de terminaison dans votre environnementVPC, vous pouvez le rendre accessible uniquement aux ressources qu'VPCil contient, ou vous pouvez associer des adresses IP élastiques et rendre votre point de terminaison accessible aux clients via Internet. Les groupes VPC de sécurité par défaut de votre choix sont automatiquement attribués à votre terminal.

Type : objet EndpointDetails

Obligatoire : non

EndpointType

Définit le type de point de terminaison auquel votre serveur est connecté. Si votre serveur est connecté à un VPC point de terminaison, il n'est pas accessible via l'Internet public.

Type : String

Valeurs valides : PUBLIC | VPC | VPC_ENDPOINT

Obligatoire : non

HostKeyFingerprint

Spécifie l'SHA256empreinte codée en Base64 de la clé d'hôte du serveur. Cette valeur est équivalente à la sortie de la ssh-keygen -l -f my-new-server-key commande.

Type : chaîne

Obligatoire : non

IdentityProviderDetails

Spécifie les informations permettant d'appeler une authentification fournie par le client. API Ce champ n'est pas renseigné lorsque le IdentityProviderType d'un serveur est AWS_DIRECTORY_SERVICE ouSERVICE_MANAGED.

Type : objet IdentityProviderDetails

Obligatoire : non

IdentityProviderType

Le mode d'authentification pour un serveur. La valeur par défaut estSERVICE_MANAGED, ce qui vous permet de stocker et d'accéder aux informations d'identification des utilisateurs au sein du AWS Transfer Family service.

AWS_DIRECTORY_SERVICEÀ utiliser pour fournir un accès aux groupes Active Directory AWS Directory Service for Microsoft Active Directory ou à Microsoft Active Directory dans votre environnement local ou à l' AWS aide d'AD Connector. Cette option exige également que vous indiquiez un ID de répertoire en utilisant le paramètre IdentityProviderDetails.

Utilisez la valeur API_GATEWAY à intégrer au fournisseur d'identité de votre choix. Le API_GATEWAY paramètre vous oblige à fournir un point de terminaison Amazon API Gateway URL à appeler pour l'authentification à l'aide du IdentityProviderDetails paramètre.

Utilisez la AWS_LAMBDA valeur pour utiliser directement une AWS Lambda fonction en tant que fournisseur d'identité. Si vous choisissez cette valeur, vous devez spécifier la ARN fonction Lambda dans le Function paramètre du type de IdentityProviderDetails données.

Type : String

Valeurs valides : SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

Obligatoire : non

LoggingRole

Le nom de ressource Amazon (ARN) du rôle AWS Identity and Access Management (IAM) qui permet à un serveur d'activer la CloudWatch journalisation Amazon pour Amazon S3 ou AmazonEFSevents. Lorsque cette option est configurée, vous pouvez consulter l'activité des utilisateurs dans vos CloudWatch journaux.

Type : String

Contraintes de longueur : longueur minimale de 0. Longueur maximale de 2048.

Modèle : (|arn:.*role/\S+)

Obligatoire : non

PostAuthenticationLoginBanner

Spécifie une chaîne à afficher lorsque les utilisateurs se connectent à un serveur. Cette chaîne s'affiche une fois l'utilisateur authentifié.

Note

Le SFTP protocole ne prend pas en charge les bannières d'affichage après authentification.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 4096.

Modèle : [\x09-\x0D\x20-\x7E]*

Obligatoire : non

PreAuthenticationLoginBanner

Spécifie une chaîne à afficher lorsque les utilisateurs se connectent à un serveur. Cette chaîne est affichée avant que l'utilisateur ne s'authentifie. Par exemple, la bannière suivante affiche des informations sur l'utilisation du système :

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.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 4096.

Modèle : [\x09-\x0D\x20-\x7E]*

Obligatoire : non

ProtocolDetails

Les paramètres du protocole qui sont configurés pour votre serveur.

  • Pour indiquer le mode passif (pour FTP et FTPS protocoles), utilisez le PassiveIp paramètre. Entrez une seule adresse à quatre points, telle que IPv4 l'adresse IP externe d'un pare-feu, d'un routeur ou d'un équilibreur de charge.

  • Pour ignorer l'erreur qui est générée lorsque le client tente d'utiliser la commande SETSTAT sur un fichier que vous téléchargez vers un compartiment Amazon S3, utilisez le paramètre SetStatOption. Pour que le AWS Transfer Family serveur ignore la SETSTAT commande et télécharge les fichiers sans avoir à apporter de modifications à votre SFTP client, définissez la valeur surENABLE_NO_OP. Si vous définissez le SetStatOption paramètre surENABLE_NO_OP, Transfer Family génère une entrée de journal dans Amazon CloudWatch Logs, afin que vous puissiez déterminer à quel moment le client passe un SETSTAT appel.

  • Pour déterminer si votre AWS Transfer Family serveur reprend les sessions récemment négociées via un identifiant de session unique, utilisez le TlsSessionResumptionMode paramètre.

  • As2Transportsindique le mode de transport des AS2 messages. Actuellement, seul HTTP est pris en charge.

Type : objet ProtocolDetails

Obligatoire : non

Protocols

Spécifie le ou les protocoles de transfert de fichiers sur lesquels votre client de protocole de transfert de fichiers peut se connecter au point de terminaison de votre serveur. Les protocoles disponibles sont :

  • SFTP(Secure Shell (SSH) File Transfer Protocol) : transfert de fichiers effectué SSH

  • FTPS(Protocole de transfert de fichiers sécurisé) : transfert de fichiers avec TLS cryptage

  • FTP (Protocole de transfert de fichiers) : Transfert de fichiers non chiffré

  • AS2(Déclaration d'applicabilité 2) : utilisé pour le transport de données structurées business-to-business

Note

  • Si vous le sélectionnezFTPS, vous devez choisir un certificat stocké dans AWS Certificate Manager (ACM) qui est utilisé pour identifier votre serveur lorsque des clients s'y connectentFTPS.

  • Si Protocol comprend FTP ou FTPS, EndpointType doit être défini sur VPC, et IdentityProviderType sur AWS_DIRECTORY_SERVICE, AWS_LAMBDA ou API_GATEWAY.

  • Si Protocol inclut FTP, alors AddressAllocationIds ne peut pas être associé.

  • Si Protocol est uniquement défini sur SFTP, EndpointType peut être défini sur PUBLIC, et IdentityProviderType peut être défini comme l'un des types d'identité pris en charge : SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA ou API_GATEWAY.

  • Si Protocol inclut AS2, alors le EndpointType doit être VPC, et le domaine doit être Amazon S3.

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 4 articles.

Valeurs valides : SFTP | FTP | FTPS | AS2

Obligatoire : non

S3StorageOptions

Spécifie si les performances de vos annuaires Amazon S3 sont optimisées ou non. Par défaut, l'option est désactivée.

Par défaut, les mappages du répertoire de base ont la valeur TYPE deDIRECTORY. Si vous activez cette option, vous devrez alors définir explicitement la valeur sur HomeDirectoryMapEntry Type FILE si vous souhaitez qu'un mappage ait une cible de fichier.

Type : objet S3StorageOptions

Obligatoire : non

SecurityPolicyName

Spécifie le nom de la politique de sécurité attachée au serveur.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 100.

Modèle : TransferSecurityPolicy-.+

Obligatoire : non

ServerId

Spécifie l'identifiant unique attribué par le système à un serveur que vous instanciez.

Type : String

Contraintes de longueur : longueur fixe de 19.

Modèle : s-([0-9a-f]{17})

Obligatoire : non

State

État du serveur décrit. La valeur de ONLINE indique que le serveur peut accepter des tâches et transférer des fichiers. StateLa valeur de OFFLINE signifie que le serveur ne peut pas effectuer d'opérations de transfert de fichiers.

Les états de STARTING et STOPPING indiquent que le serveur est dans un état intermédiaire, qu'il n'est pas totalement en mesure de répondre ou qu'il n'est pas complètement hors ligne. Les valeurs de START_FAILED ou STOP_FAILED peuvent indiquer une condition d'erreur.

Type : String

Valeurs valides : OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

Obligatoire : non

StructuredLogDestinations

Spécifie les groupes de journaux auxquels les journaux de votre serveur sont envoyés.

Pour spécifier un groupe de journaux, vous devez fournir le correspondant ARN à un groupe de journaux existant. Dans ce cas, le format du groupe de logs est le suivant :

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

Par exemple, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

Si vous avez déjà spécifié un groupe de journaux pour un serveur, vous pouvez l'effacer, et donc désactiver la journalisation structurée, en fournissant une valeur vide pour ce paramètre dans un update-server appel. Par exemple :

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

Type : tableau de chaînes

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 1 élément.

Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.

Modèle : arn:\S+

Obligatoire : non

Tags

Spécifie les paires clé-valeur que vous pouvez utiliser pour rechercher et regrouper les serveurs assignés au serveur décrit.

Type : tableau d’objets Tag

Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.

Obligatoire : non

UserCount

Spécifie le nombre d'utilisateurs affectés à un serveur que vous avez spécifié avec leServerId.

Type : entier

Obligatoire : non

WorkflowDetails

Spécifie l'ID du flux de travail à attribuer et le rôle d'exécution utilisé pour exécuter le flux de travail.

En plus d'un flux de travail à exécuter lorsqu'un fichier est complètement chargé, WorkflowDetails peut également contenir un ID de flux de travail (et un rôle d'exécution) pour un flux de travail à exécuter lors d'un chargement partiel. Un téléchargement partiel se produit lorsque la session du serveur se déconnecte alors que le fichier est toujours en cours de téléchargement.

Type : objet WorkflowDetails

Obligatoire : non

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :