DescribedServer - AWS Transfer Family

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à.

DescribedServer

Descrive le proprietà di un server abilitato al protocollo di trasferimento file specificato.

Indice

Arn

Speciifica l'Amazon Resource Name (ARN) univoco del server.

▬Tipo: stringa

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

Modello: arn:\S+

Campo obbligatorio: sì

As2ServiceManagedEgressIpAddresses

L'elenco degli indirizzi IP di uscita di questo server. Questi indirizzi IP sono rilevanti solo per i server che utilizzano il protocollo AS2. Vengono utilizzati per l'invio di mDNS asincroni.

Questi indirizzi IP vengono assegnati automaticamente quando si crea un server AS2. Inoltre, se si aggiorna un server esistente e si aggiunge il protocollo AS2, vengono assegnati anche indirizzi IP statici.

Tipo: matrice di stringhe

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

Campo obbligatorio: no

Certificate

Speciifica l'ARN del certificato Certificate AWS Manager (ACM). Obbligatorio quando Protocols è impostato su FTPS.

▬Tipo: stringa

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

Campo obbligatorio: no

Domain

Specifica 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.

▬Tipo: stringa

Valori validi: S3 | EFS

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

Definisce il tipo di endpoint a cui è connesso il server. Se il server è connesso a un endpoint VPC, il server non è accessibile tramite la rete Internet pubblica.

▬Tipo: stringa

Valori validi: PUBLIC | VPC | VPC_ENDPOINT

Campo obbligatorio: no

HostKeyFingerprint

Specifica l'impronta digitale SHA256 con codifica Base64 della chiave host del server. Questo valore è equivalente all'output del comando. ssh-keygen -l -f my-new-server-key

▬Tipo: stringa

Campo obbligatorio: no

IdentityProviderDetails

Specificate le informazioni per chiamare un'API di autenticazione fornita dal cliente. Questo campo non viene compilato quando il valore IdentityProviderType di un server è o. AWS_DIRECTORY_SERVICE 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 AWS Transfer Family servizio.

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'impostazione API_GATEWAY richiede di fornire un URL dell'endpoint del Gateway Amazon API da richiamare per l'autenticazione utilizzando il parametro IdentityProviderDetails.

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

▬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 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 abiliti questa opzione, dovrai quindi impostarla in modo esplicito FILE se desideri 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

Speciifica l'identificatore univoco assegnato dal sistema per un server creato dall'utente.

▬Tipo: stringa

Vincoli di lunghezza: lunghezza fissa di 19.

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

Campo obbligatorio: no

State

La condizione del server descritta. Il valore di ONLINE indica che il server può accettare lavori e trasferire file. Un State valore di OFFLINE indica che il server non è in grado di eseguire operazioni di trasferimento di file.

Gli stati di STARTING e STOPPING indicano che il server si trova in uno stato intermedio, ovvero non è completamente in grado di rispondere o non è completamente offline. I valori di START_FAILED o STOP_FAILED possono indicare una condizione di errore.

▬Tipo: stringa

Valori validi: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

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 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

Tags

Speciifica le coppie chiave-valore che è possibile utilizzare per cercare e raggruppare i server assegnati al server descritto.

Tipo: matrice di oggetti Tag

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

Campo obbligatorio: no

UserCount

Speciifica il numero di utenti assegnati a un server specificato con. ServerId

Tipo: integer

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

Vedi anche

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