UpdateServer

Met à jour les propriétés du serveur compatible avec le protocole de transfert de fichiers une fois que celui-ci a été créé.

L'UpdateServerappel renvoie le ServerId serveur que vous avez mis à jour.

Syntaxe de la requête

{
   "Certificate": "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"
   },
   "LoggingRole": "string",
   "PostAuthenticationLoginBanner": "string",
   "PreAuthenticationLoginBanner": "string",
   "ProtocolDetails": { 
      "As2Transports": [ "string" ],
      "PassiveIp": "string",
      "SetStatOption": "string",
      "TlsSessionResumptionMode": "string"
   },
   "Protocols": [ "string" ],
   "S3StorageOptions": { 
      "DirectoryListingOptimization": "string"
   },
   "SecurityPolicyName": "string",
   "ServerId": "string",
   "StructuredLogDestinations": [ "string" ],
   "WorkflowDetails": { 
      "OnPartialUpload": [ 
         { 
            "ExecutionRole": "string",
            "WorkflowId": "string"
         }
      ],
      "OnUpload": [ 
         { 
            "ExecutionRole": "string",
            "WorkflowId": "string"
         }
      ]
   }
}

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

Cette demande accepte les données suivantes au format JSON.

Certificate

Amazon Resource Name (ARN) du AWS certificat Certificate Manager (ACM). Obligatoire lorsque Protocols est défini sur FTPS.

Pour demander un nouveau certificat public, consultez la section Request a public certificate dans le guide de l'utilisateur de AWS Certificate Manager.

Pour importer un certificat existant dans ACM, consultez la section Importation de certificats dans ACM dans le guide de l'utilisateur de AWS Certificate Manager.

Pour demander un certificat privé afin d'utiliser le protocole FTPS via des adresses IP privées, consultez la section Request a private certificate dans le guide de l'utilisateur de AWS Certificate Manager.

Les certificats avec les algorithmes de chiffrement et les tailles de clés suivants sont pris en charge :

• RSA 2048 octets (RSA_2048)

• RSA 4 096 octets (RSA_4096)

• Elliptic Prime Curve 256 octets (EC_prime256v1)

• Elliptic Prime Curve 384 octets (EC_secp384r1)

• Elliptic Prime Curve 521 octets (EC_secp521r1)

Note

Le certificat doit être un certificat SSL/TLS X.509 version 3 valide avec un nom de domaine complet ou une adresse IP spécifiée ainsi que des informations sur l'émetteur.

Type : chaîne

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

Obligatoire : non

EndpointDetails

Paramètres du point de terminaison VPC qui sont configurés pour votre serveur. Lorsque vous hébergez votre point de terminaison dans votre VPC, vous pouvez le rendre accessible uniquement aux ressources de votre VPC, ou vous pouvez joindre des adresses IP Elastic et rendre votre point de terminaison accessible aux clients sur Internet. Les groupes de sécurité par défaut de votre VPC sont automatiquement affectés à votre point de terminaison.

Type : objet EndpointDetails

Obligatoire : non

EndpointType

Le type de point de terminaison que vous souhaitez que votre serveur utilise. Vous pouvez choisir de rendre le point de terminaison de votre serveur accessible au public (PUBLIC) ou de l'héberger dans votre VPC. Avec un point de terminaison qui est hébergé dans un VPC, vous pouvez restreindre l'accès à votre serveur et aux ressources uniquement dans votre VPC ou choisir de le rendre accessible à Internet en y attachant directement des adresses IP Elastic.

Note

Après le 19 mai 2021, vous ne pourrez plus créer de serveur EndpointType=VPC_ENDPOINT à l'aide de votre AWS compte si celui-ci ne l'a pas déjà fait avant le 19 mai 2021. Si vous avez déjà créé des serveurs EndpointType=VPC_ENDPOINT dans votre AWS compte le 19 mai 2021 ou avant, vous ne serez pas concerné. Après cette date, utilisez EndpointType =VPC.

Pour plus d’informations, consultez Arrêt de l'utilisation de VPC_ENDPOINT.

Il est recommandé d'utiliser VPC comme élément EndpointType. Avec ce type de point de terminaison, vous avez la possibilité d'associer directement jusqu'à trois adresses IPv4 Elastic (BYO IP incluse) au point de terminaison de votre serveur et d'utiliser des groupes de sécurité VPC pour restreindre le trafic par l'adresse IP publique du client. Cela n'est pas possible si EndpointType est défini sur VPC_ENDPOINT.

Type : chaîne

Valeurs valides : PUBLIC | VPC | VPC_ENDPOINT

Obligatoire : non

HostKey

La clé privée RSA, ECDSA ou ED25519 à utiliser pour votre serveur compatible SFTP. Vous pouvez ajouter plusieurs clés hôtes, au cas où vous souhaiteriez faire pivoter les clés, ou disposer d'un ensemble de clés actives utilisant différents algorithmes.

Utilisez la commande suivante pour générer une clé RSA 2048 bits sans phrase secrète :

ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

Utilisez une valeur minimale de 2 048 pour l'-boption. Vous pouvez créer une clé plus forte en utilisant 3072 ou 4096.

Utilisez la commande suivante pour générer une clé ECDSA 256 bits sans phrase secrète :

ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

Les valeurs valides pour l'-boption ECDSA sont 256, 384 et 521.

Utilisez la commande suivante pour générer une clé ED25519 sans phrase secrète :

ssh-keygen -t ed25519 -N "" -f my-new-server-key.

Pour toutes ces commandes, vous pouvez les remplacer my-new-server-keypar une chaîne de votre choix.

Important

Si vous ne prévoyez pas de migrer des utilisateurs existants d'un serveur SFTP existant vers un nouveau serveur, ne mettez pas à jour la clé d'hôte. La modification accidentelle de la clé d'hôte d’un serveur peut être perturbante.

Pour plus d'informations, voir Mettre à jour les clés d'hôte pour votre serveur compatible SFTP dans le guide de l' AWS Transfer Family utilisateur.

Type : chaîne

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

Obligatoire : non

IdentityProviderDetails

Tableau contenant toutes les informations requises pour appeler la méthode d'API d'authentification d'un client.

Type : objet IdentityProviderDetails

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 Amazon EFSEvents. Lorsque cette option est configurée, vous pouvez consulter l'activité des utilisateurs dans vos CloudWatch journaux.

Type : chaîne

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 protocole SFTP ne prend pas en charge les bannières d'affichage post-authentification.

Type : chaîne

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 : chaîne

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 les protocoles FTP et FTPS), utilisez le paramètre PassiveIp. Saisissez une adresse IPv4 unique sous forme de quadruplet, telle que 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 client SFTP, définissez la valeur sur. ENABLE_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.

• As2Transports indique la méthode de transport des messages AS2. Actuellement, seul le protocole 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 via SSH

• FTPS (File Transfer Protocol Secure) : Transfert de fichiers avec chiffrement TLS

• 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 connectent via FTPS.

• 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é du serveur.

Type : chaîne

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

Modèle : Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+

Obligatoire : non

ServerId

Identifiant unique attribué par le système pour une instance de serveur à laquelle l'utilisateur Transfer Family est affecté.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

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

Obligatoire : oui

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 l'ARN d'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

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.

Pour supprimer un flux de travail associé d'un serveur, vous pouvez fournir un objet OnUpload vide, comme dans l'exemple suivant.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

Type : objet WorkflowDetails

Obligatoire : non

Syntaxe de la réponse

{
   "ServerId": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

ServerId

Identifiant unique attribué par le système à un serveur auquel l'utilisateur de Transfer Family est affecté.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

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

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Vous ne disposez pas d’un accès suffisant pour effectuer cette action.

Code d’état HTTP : 400

ConflictException

Cette exception est levée lorsqu'un serveur compatible avec le UpdateServer protocole de transfert de fichiers dont le type de point de terminaison est VPC est appelé et que celui du serveur n'VpcEndpointIDest pas disponible.

Code d’état HTTP : 400

InternalServiceError

Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.

Code d’état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

ResourceExistsException

La ressource demandée n'existe pas ou existe dans une région autre que celle spécifiée pour la commande.

Code d’état HTTP : 400

ResourceNotFoundException

Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué car le service AWS Transfer Family n'est pas disponible.

Code d’état HTTP : 500

ThrottlingException

La demande a été refusée suite à une limitation des demandes.

Code d’état HTTP : 400

Exemples

Exemple

L'exemple suivant met à jour le rôle d'un serveur.

Exemple de demande

{
   "EndpointDetails": { 
   "VpcEndpointId": "vpce-01234f056f3g13",
   "LoggingRole": "CloudWatchS3Events",
   "ServerId": "s-01234567890abcdef"
   }
}

Exemple

L'exemple suivant supprime tous les flux de travail associés du serveur.

Exemple de demande

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

Exemple

Il s'agit d'un exemple de réponse pour cet appel d'API.

Exemple de réponse

{
   "ServerId": "s-01234567890abcdef"
}

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• AWS SDK pour C++

• AWS SDK pour Go v2

• AWS SDK pour Java V2

• AWS SDK pour V3 JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• AWS SDK pour Ruby V3