UpdateServer - AWS Transfer Family
Sintassi della richiestaParametri della richiestaSintassi della rispostaElementi di rispostaErroriEsempiVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

UpdateServer

Aggiorna le proprietà del server abilitato al protocollo di trasferimento file dopo la creazione del server.

La UpdateServer chiamata restituisce il ServerId nome del server aggiornato.

Sintassi della richiesta

{
   "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"
         }
      ]
   }
}

Parametri della richiesta

Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.

La richiesta accetta i seguenti dati in formato JSON.

Certificate

L'Amazon Resource Name (ARN) del AWS certificato Certificate Manager (ACM). Obbligatorio quando Protocols è impostato su FTPS.

Per richiedere un nuovo certificato pubblico, consulta Richiedere un certificato pubblico nella Guida per l'utente di AWS Certificate Manager.

Per importare un certificato esistente in ACM, consulta Importazione di certificati in ACM nella Guida per l'utente di AWS Certificate Manager.

Per richiedere un certificato privato per utilizzare FTPS tramite indirizzi IP privati, consulta Richiedere un certificato privato nella Guida per l'utente di AWS Certificate Manager.

Sono supportati i certificati con gli algoritmi di crittografia e le dimensioni delle chiavi seguenti:

  • RSA a 2048 bit (RSA_2048)

  • RSA a 4096 bit (RSA_4096)

  • Elliptic Prime Curve a 256 bit (EC_prime256v1)

  • Elliptic Prime Curve a 384 bit (EC_secp384r1)

  • Elliptic Prime Curve a 521 bit (EC_secp521r1)

Nota

Il certificato deve essere un certificato SSL/TLS X.509 versione 3 valido con FQDN o indirizzo IP specificato e le informazioni sull'emittente.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 1600 caratteri.

Campo obbligatorio: no

EndpointDetails

Le impostazioni dell'endpoint del cloud privato virtuale (VPC) configurate per il server. Quando esegui l'hosting dell'endpoint all'interno del tuo VPC, puoi renderlo accessibile solo alle risorse nel VPC oppure collegarvi indirizzi IP elastici e renderlo accessibile ai client tramite Internet. I gruppi di sicurezza predefiniti del VPC vengono assegnati automaticamente all'endpoint.

Tipo: oggetto EndpointDetails

Campo obbligatorio: no

EndpointType

Il tipo di endpoint VPC che il server deve utilizzare. È possibile scegliere di rendere l'endpoint del server accessibile pubblicamente (PUBLIC) o ospitarlo all'interno del proprio VPC. Nel caso di un endpoint ospitato in un VPC, è possibile consentire l'accesso solo al server e alle risorse all'interno del VPC o scegliere di renderlo accessibile tramite Internet collegandolo direttamente a indirizzi IP elastici.

Nota

Dopo il 19 maggio 2021, non potrai creare un server utilizzando EndpointType=VPC_ENDPOINT il tuo AWS account se il tuo account non l'ha già fatto prima del 19 maggio 2021. Se hai già creato dei server EndpointType=VPC_ENDPOINT nel tuo AWS account entro il 19 maggio 2021 o prima, non ne subirai alcuna modifica. Dopo questa data, usa EndpointType =VPC.

Per ulteriori informazioni, consulta Interruzione dell'uso di VPC_ENDPOINT.

È consigliabile utilizzare VPC come EndpointType. Con questo tipo di endpoint, è possibile associare direttamente fino a tre indirizzi IPv4 elastici (anche IP BYO) all'endpoint del server e utilizzare i gruppi di sicurezza VPC per limitare il traffico tramite l'indirizzo IP pubblico del client. Questo non è possibile se EndpointType è impostato su VPC_ENDPOINT.

▬Tipo: stringa

Valori validi: PUBLIC | VPC | VPC_ENDPOINT

Campo obbligatorio: no

HostKey

La chiave privata RSA, ECDSA o ED25519 da utilizzare per il server compatibile con SFTP. È possibile aggiungere più chiavi host, nel caso in cui si desideri ruotare le chiavi, o disporre di un set di chiavi attive che utilizzano algoritmi diversi.

Utilizzate il seguente comando per generare una chiave RSA a 2048 bit senza passphrase:

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

Utilizzate un valore minimo di 2048 per l'opzione. -b È possibile creare una chiave più potente utilizzando 3072 o 4096.

Utilizzate il seguente comando per generare una chiave ECDSA a 256 bit senza passphrase:

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

I valori validi per l'-bopzione per ECDSA sono 256, 384 e 521.

Utilizzate il seguente comando per generare una chiave ED25519 senza passphrase:

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

Puoi sostituire tutti questi comandi my-new-server-keycon una stringa a tua scelta.

Importante

Se non avete intenzione di migrare gli utenti esistenti da un server esistente che supporta SFTP a un nuovo server, non aggiornate la chiave host. La modifica accidentale della chiave host di un server può creare problemi.

Per ulteriori informazioni, consulta Aggiornare le chiavi host per il server compatibile con SFTP nella Guida per l'utente. AWS Transfer Family

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. Lunghezza massima di 4096.

Campo obbligatorio: no

IdentityProviderDetails

Un array contenente tutte le informazioni necessarie per richiamare il metodo API di autenticazione di un cliente.

Tipo: oggetto IdentityProviderDetails

Campo obbligatorio: no

LoggingRole

L'Amazon Resource Name (ARN) del ruolo AWS Identity and Access Management (IAM) che consente a un server di attivare la CloudWatch registrazione Amazon per Amazon S3 o Amazon EFSEvents. Una volta impostato, puoi visualizzare l'attività degli utenti nei tuoi log. CloudWatch

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 2048 caratteri.

Modello: (|arn:.*role/\S+)

Campo obbligatorio: no

PostAuthenticationLoginBanner

Specifica una stringa da visualizzare quando gli utenti si connettono a un server. Questa stringa viene visualizzata dopo l'autenticazione dell'utente.

Nota

Il protocollo SFTP non supporta banner di visualizzazione post-autenticazione.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. Lunghezza massima di 4096.

Modello: [\x09-\x0D\x20-\x7E]*

Campo obbligatorio: no

PreAuthenticationLoginBanner

Specifica una stringa da visualizzare quando gli utenti si connettono a un server. Questa stringa viene visualizzata prima dell'autenticazione dell'utente. Il seguente banner, ad esempio, mostra i dettagli sull'utilizzo del sistema:

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.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. Lunghezza massima di 4096.

Modello: [\x09-\x0D\x20-\x7E]*

Campo obbligatorio: no

ProtocolDetails

Le impostazioni del protocollo configurate per il server.

  • Per indicare la modalità passiva (per i protocolli FTP e FTPS), utilizza il parametro PassiveIp. Inserire un singolo indirizzo IPv4 composto da 4 numeri decimali separati da punti, ad esempio l'indirizzo IP esterno di un firewall, un router o un load balancer.

  • Per ignorare l'errore generato quando il client tenta di utilizzare il comando SETSTAT su un file che stai caricando su un bucket Amazon S3, utilizza il parametro SetStatOption. Per fare in modo che il AWS Transfer Family server ignori il SETSTAT comando e carichi i file senza dover apportare modifiche al client SFTP, imposta il valore su. ENABLE_NO_OP Se imposti il SetStatOption parametro suENABLE_NO_OP, Transfer Family genera una voce di registro in Amazon CloudWatch Logs, in modo da poter determinare quando il client sta effettuando una SETSTAT chiamata.

  • Per determinare se il AWS Transfer Family server riprende le sessioni negoziate recenti tramite un ID di sessione univoco, utilizza il parametro. TlsSessionResumptionMode

  • As2Transports indica il metodo di trasporto per i messaggi AS2. Attualmente è supportato solo HTTP.

Tipo: oggetto ProtocolDetails

Campo obbligatorio: no

Protocols

Specifica il protocollo o i protocolli di trasferimento file su cui il client del protocollo di trasferimento file può connettersi all'endpoint del server. I protocolli disponibili sono:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): trasferimento di file su SSH

  • FTPS File Transfer Protocol Secure: trasferimento di file con crittografia TLS

  • FTP (File Transfer Protocol): trasferimento file non crittografato

  • AS2(Dichiarazione di applicabilità 2): utilizzata per il trasporto di dati strutturati business-to-business

Nota

  • Se si selezionaFTPS, è necessario scegliere un certificato archiviato in AWS Certificate Manager (ACM) che viene utilizzato per identificare il server quando i client si connettono ad esso tramite FTPS.

  • Se Protocol include FTP o FTPS, EndpointType deve essere VPC e IdentityProviderType deve essere AWS_DIRECTORY_SERVICE, AWS_LAMBDA o API_GATEWAY.

  • Se Protocol include FTP, AddressAllocationIds non può essere associato.

  • Se Protocol è impostato solo su SFTP, EndpointType può essere impostato su PUBLIC e IdentityProviderType può essere impostato uno qualunque dei tipi di identità supportati: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA o API_GATEWAY.

  • Se Protocol include AS2, EndpointType deve essere VPC e il dominio deve essere Amazon S3.

Tipo: matrice di stringhe

Membri dell’array: numero minimo di 1 elemento. Numero massimo di 4 articoli.

Valori validi: SFTP | FTP | FTPS | AS2

Campo obbligatorio: no

S3StorageOptions

Indica se le prestazioni per le tue directory Amazon S3 sono ottimizzate o meno. Questa opzione è disabilitata per impostazione predefinita.

Per impostazione predefinita, le mappature delle home directory hanno un valore di. TYPE DIRECTORY Se si abilita questa opzione, è necessario impostarla esplicitamente su FILE se si desidera che una mappatura abbia un file di destinazione. HomeDirectoryMapEntry Type

Tipo: oggetto S3StorageOptions

Campo obbligatorio: no

SecurityPolicyName

Speciifica il nome della politica di sicurezza per il server.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. Lunghezza massima di 100.

Modello: Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+

Campo obbligatorio: no

ServerId

Un identificatore univoco assegnato dal sistema per un'istanza del server a cui è assegnato l'utente Transfer Family.

▬Tipo: stringa

Vincoli di lunghezza: lunghezza fissa di 19.

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

Campo obbligatorio: sì

StructuredLogDestinations

Speciifica i gruppi di log a cui vengono inviati i log del server.

Per specificare un gruppo di log, è necessario fornire l'ARN per un gruppo di log esistente. In questo caso, il formato del gruppo di log è il seguente:

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

Ad esempio, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

Se in precedenza è stato specificato un gruppo di log per un server, è possibile cancellarlo e di fatto disattivare la registrazione strutturata fornendo un valore vuoto per questo parametro in una update-server chiamata. Per esempio:

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

Tipo: matrice di stringhe

Membri dell'array: numero minimo di 0 elementi. Numero massimo di 1 elemento.

Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 1600 caratteri.

Modello: arn:\S+

Campo obbligatorio: no

WorkflowDetails

Specifica l'ID del flusso di lavoro da assegnare e il ruolo di esecuzione utilizzato per l'esecuzione del flusso di lavoro.

Oltre a un flusso di lavoro da eseguire quando un file viene caricato completamente, WorkflowDetails può contenere anche un ID del flusso di lavoro (e ruolo di esecuzione) per l'esecuzione di un flusso di lavoro in caso di caricamento parziale. Un caricamento parziale si verifica quando la sessione del server si disconnette mentre il file è ancora in fase di caricamento.

Per rimuovere un flusso di lavoro associato da un server, è possibile fornire un oggetto OnUpload vuoto, come nel seguente esempio.

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

Tipo: oggetto WorkflowDetails

Campo obbligatorio: no

Sintassi della risposta

{
   "ServerId": "string"
}

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

ServerId

Un identificatore univoco assegnato dal sistema per un server a cui è assegnato l'utente Transfer Family.

▬Tipo: stringa

Vincoli di lunghezza: lunghezza fissa di 19.

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

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

AccessDeniedException

Non disponi dell'autorizzazione di accesso sufficiente per eseguire questa operazione.

Codice di stato HTTP: 400

ConflictException

Questa eccezione viene generata quando UpdateServer viene chiamato per un server abilitato al protocollo di trasferimento file che ha VPC come tipo di endpoint e quello del server non VpcEndpointID è nello stato disponibile.

Codice di stato HTTP: 400

InternalServiceError

Questa eccezione viene generata quando si verifica un errore nel servizio. AWS Transfer Family

Codice di stato HTTP: 500

InvalidRequestException

Questa eccezione viene generata quando il client invia una richiesta non valida.

Codice di stato HTTP: 400

ResourceExistsException

La risorsa richiesta non esiste o esiste in una regione diversa da quella specificata per il comando.

Codice di stato HTTP: 400

ResourceNotFoundException

Questa eccezione viene generata quando una risorsa non viene trovata dal servizio AWS Transfer Family.

Codice di stato HTTP: 400

ServiceUnavailableException

La richiesta non è riuscita perché il servizio AWS Transfer Family non è disponibile.

Codice di stato HTTP: 500

ThrottlingException

La richiesta è stata negata a causa del throttling della richiesta.

Codice di stato HTTP: 400

Esempi

Esempio

L'esempio seguente aggiorna il ruolo di un server.

Richiesta di esempio


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

Esempio

L'esempio seguente rimuove tutti i flussi di lavoro associati dal server.

Richiesta di esempio

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

Esempio

Questo è un esempio di risposta per questa chiamata API.

Risposta di esempio

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

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: