Sintassi della richiesta Parametri della richiesta Sintassi della risposta Elementi di risposta Errori Esempi Vedi anche

CreateServer

Crea l'istanza di un server virtuale a dimensionamento automatico basato sul protocollo FTP selezionato in AWS. Quando si aggiorna il server abilitato al protocollo FTP o quando si usano gli utenti, utilizzare la proprietà ServerId generata dal servizio che viene assegnata al server appena creato.

Sintassi della richiesta


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

Parametri della richiesta

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

La richiesta accetta i seguenti dati nel JSON formato.

Certificate

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

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

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

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

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

2048 bit RSA (_2048) RSA
4096 bit (_4096) RSA RSA
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 l'indirizzo IP specificato e le informazioni sull'FQDNemittente.

Tipo: stringa

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

Campo obbligatorio: no

Domain

Il dominio del sistema di storage utilizzato per i trasferimenti di file. Sono disponibili due domini: Amazon Simple Storage Service (Amazon S3) e Amazon Elastic File System (Amazon). EFS Il valore predefinito è S3.

Nota

Dopo la creazione del server, il dominio non può essere modificato.

Tipo: stringa

Valori validi: S3 | EFS

Campo obbligatorio: no

EndpointDetails

Le impostazioni degli endpoint del cloud privato virtuale (VPC) configurate per il server. Quando ospitate l'endpoint all'interno del vostroVPC, potete rendere l'endpoint accessibile solo alle risorse interne oppure potete collegare indirizzi IP elastici e rendere l'endpoint accessibile ai client su Internet. VPC I gruppi VPC di sicurezza predefiniti vengono assegnati automaticamente all'endpoint.

Tipo: oggetto EndpointDetails

Campo obbligatorio: no

EndpointType

Il tipo di endpoint VPC che il server deve utilizzare. Puoi scegliere di rendere l'endpoint del tuo server accessibile al pubblico (PUBLIC) o ospitarlo all'interno del tuo. VPC Con un endpoint ospitato in un serverVPC, puoi limitare l'accesso al server e alle risorse solo all'interno del tuo dispositivo VPC o scegliere di renderlo accessibile a Internet collegando direttamente gli indirizzi IP elastici.

Nota

Dopo il 19 maggio 2021, non potrai creare un server utilizzando EndpointType=VPC_ENDPOINT in your Account AWS se il tuo account non l'ha già fatto prima del 19 maggio 2021. Se hai già creato dei server con EndpointType=VPC_ENDPOINT in your Account AWS 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, hai la possibilità di associare direttamente fino a tre IPv4 indirizzi elastici (BYOIP incluso) all'endpoint del tuo server e utilizzare i gruppi di VPC sicurezza per limitare il traffico in base all'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 RSAECDSA, o chiave ED25519 privata, da utilizzare per il server SFTP abilitato. È 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 a RSA 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 a ECDSA 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 ED25519 chiave 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 hai intenzione di migrare gli utenti esistenti da un server SFTP abilitato esistente a un nuovo server, non aggiornare 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 SFTP abilitato nella Guida per l' AWS Transfer Family utente.

Tipo: stringa

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

Campo obbligatorio: no

IdentityProviderDetails

Richiesto quando IdentityProviderType è impostato suAWS_DIRECTORY_SERVICE, AWS_LAMBDA oAPI_GATEWAY. Accetta un array contenente tutte le informazioni necessarie per utilizzare una directory AWS_DIRECTORY_SERVICE o richiamare un'autenticazione fornita dal clienteAPI, incluso il Gateway. API URL Obbligatorio quando IdentityProviderType è impostato su SERVICE_MANAGED.

Tipo: oggetto IdentityProviderDetails

Campo obbligatorio: no

IdentityProviderType

La modalità di autenticazione di un server. Il valore predefinito èSERVICE_MANAGED, che consente di archiviare e accedere alle credenziali utente all'interno del servizio. AWS Transfer Family

AWS_DIRECTORY_SERVICEUtilizzalo per fornire l'accesso ai gruppi di Active Directory in AWS Directory Service for Microsoft Active Directory o Microsoft Active Directory nell'ambiente locale o AWS utilizzando AD Connector. Questa opzione prevede inoltre che l'utente fornisca un ID directory utilizzando il parametro IdentityProviderDetails.

Utilizza il valore API_GATEWAY da integrare con un provider di identità a scelta. L'API_GATEWAYimpostazione richiede di fornire un endpoint Amazon API Gateway da URL chiamare per l'autenticazione utilizzando il IdentityProviderDetails parametro.

Usa il AWS_LAMBDA valore per utilizzare direttamente una AWS Lambda funzione come provider di identità. Se scegli questo valore, devi specificare la ARN funzione Lambda nel Function parametro per il tipo di IdentityProviderDetails dati.

Tipo: stringa

Valori validi: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

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 CloudWatch log.

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 SFTP protocollo non supporta i banner di visualizzazione successivi all'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 FTP e FTPS protocolli), utilizzate il PassiveIp parametro. Immettete un unico indirizzo quadruplo punteggiato, ad esempio l'IPv4indirizzo IP esterno di un firewall, un router o un sistema di bilanciamento del carico.
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 SFTP client, 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
As2Transportsindica il metodo di trasporto dei 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 tramite SSH
FTPS(File Transfer Protocol Secure): trasferimento di file con TLS crittografia
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. 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 elementi.

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

Specifica il nome della policy di sicurezza collegata al server.

Tipo: stringa

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

Modello: TransferSecurityPolicy-.+

Campo obbligatorio: no

StructuredLogDestinations

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

Per specificare un gruppo di log, è necessario fornire il file 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

Tags

Le coppie chiave-valore che è possibile utilizzare per raggruppare e cercare i server.

Tipo: matrice di oggetti Tag

Membri dell’array: numero minimo di 1 elemento. Numero massimo di 50 item.

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.

Tipo: oggetto WorkflowDetails

Campo obbligatorio: no

Sintassi della risposta


{
   "ServerId": "string"
}

Elementi di risposta

Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.

I seguenti dati vengono restituiti in JSON formato dal servizio.

ServerId

L'identificatore assegnato dal servizio del server che viene creato.

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.

HTTPCodice di stato: 400

InternalServiceError

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

HTTPCodice di stato: 500

InvalidRequestException

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

HTTPCodice di stato: 400

ResourceExistsException

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

HTTPCodice di stato: 400

ResourceNotFoundException

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

HTTPCodice di stato: 400

ServiceUnavailableException

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

HTTPCodice di stato: 500

ThrottlingException

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

HTTPCodice di stato: 400

Esempi

Esempio

L'esempio seguente crea un nuovo server utilizzando unVPC_ENDPOINT.

Richiesta di esempio


{     
   "EndpointType": "VPC",
   "EndpointDetails":...,
   "HostKey": "Your RSA private key",
   "IdentityProviderDetails": "IdentityProvider",
   "IdentityProviderType": "SERVICE_MANAGED",
   "LoggingRole": "CloudWatchLoggingRole",
   "Tags": [ 
      { 
         "Key": "Name",
         "Value": "MyServer"
      }
   ]
}

Esempio

Questo è un esempio di risposta per questa API chiamata.

Risposta di esempio


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

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API opzione in una delle lingue specifiche AWS SDKs, consulta quanto segue:

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

CreateProfile

CreateUser