CreateLocationSmb - AWS DataSync

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

CreateLocationSmb

Crea una posizione di trasferimento per un file server Server Message Block (SMB). AWS DataSync può utilizzare questa posizione come origine o destinazione per il trasferimento di dati.

Prima di iniziare, assicurati di aver compreso come DataSync accede ai file server SMB. Per ulteriori informazioni, consulta Fornire DataSync l'accesso ai file server SMB.

Sintassi della richiesta

{ "AgentArns": [ "string" ], "AuthenticationType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "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.

AgentArns

Speciifica l' DataSync agente (o gli agenti) che possono connettersi al file server SMB. Specifichi un agente utilizzando il relativo Amazon Resource Name (ARN).

Tipo: array di stringhe

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

Limitazioni di lunghezza: lunghezza massima di 128.

Modello: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Obbligatorio: sì

AuthenticationType

Speciifica il protocollo di autenticazione DataSync utilizzato per connettersi al file server SMB. DataSync supporta NTLM (impostazione predefinita) e KERBEROS autenticazione.

Per ulteriori informazioni, vedere Fornire DataSync l'accesso ai file server SMB.

Tipo: String

Valori validi: NTLM | KERBEROS

Campo obbligatorio: no

CmkSecretConfig

Specifica le informazioni di configurazione per un segreto DataSync gestito, un Password o KerberosKeytab NTLM (per impostazione predefinita) e i tipi di KERBEROS autenticazione, rispettivamente) da DataSync utilizzare per accedere a una posizione di archiviazione SMB specifica, con un server gestito dal cliente. AWS KMS key

Quando includi questo parametro come parte di una CreateLocationSmbRequest richiesta, fornisci solo l'ARN della chiave KMS. DataSync utilizza questa chiave KMS insieme al Password o KerberosKeytab specificato per creare un segreto DataSync gestito per archiviare le credenziali di accesso alla posizione.

Assicurati di disporre DataSync dell'autorizzazione per accedere alla chiave KMS specificata.

Nota

Puoi utilizzare CmkSecretConfig (con uno dei due Password oKerberosKeytab) o CustomSecretConfig (senza Password eKerberosKeytab) per fornire le credenziali per una CreateLocationSmbRequest richiesta. Non fornite entrambi CmkSecretConfig i CustomSecretConfig parametri per la stessa richiesta.

Tipo: oggetto CmkSecretConfig

Obbligatorio: no

CustomSecretConfig

Specifica le informazioni di configurazione per un segreto di Secrets Manager gestito dal cliente in cui le credenziali della posizione di archiviazione SMB sono archiviate in Secrets Manager come testo semplice (perPassword) o binario (per). KerberosKeytab Questa configurazione include l'ARN segreto e l'ARN per un ruolo IAM che fornisce l'accesso al segreto.

Nota

È possibile utilizzare CmkSecretConfig (conSasConfiguration) o CustomSecretConfig (senzaSasConfiguration) per fornire le credenziali per una richiesta. CreateLocationSmbRequest Non fornite entrambi i parametri per la stessa richiesta.

Tipo: oggetto CustomSecretConfig

Obbligatorio: no

DnsIpAddresses

Speciifica gli IPv6 indirizzi IPv4 o per i server DNS a cui appartiene il file server SMB. Questo parametro si applica solo se AuthenticationType è impostato su. KERBEROS

Se nell'ambiente sono presenti più domini, la configurazione di questo parametro assicura la DataSync connessione al file server SMB corretto.

Tipo: array di stringhe

Membri della matrice: numero massimo di 2 elementi.

Limitazioni di lunghezza: lunghezza minima pari a 7. Lunghezza massima di 39.

Modello: \A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z

Obbligatorio: no

Domain

Specifica il nome dominio di Windows a cui appartiene il server di file SMB. Questo parametro si applica solo se AuthenticationType è impostato suNTLM.

Se nell'ambiente sono presenti più domini, la configurazione di questo parametro assicura la DataSync connessione al file server corretto.

Tipo: String

Vincoli di lunghezza: lunghezza massima di 253.

Modello: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

Obbligatorio: no

KerberosKeytab

Speciifica il file della tabella delle chiavi Kerberos (keytab), che include le mappature tra la chiave principale Kerberos e la chiave di crittografia.

Per evitare errori di esecuzione delle attività, assicurati che il principale Kerberos utilizzato per creare il file keytab corrisponda esattamente a quello specificato. KerberosPrincipal

Tipo: oggetto dati binari con codifica Base64

Vincoli di lunghezza: lunghezza massima di 65536.

Obbligatorio: no

KerberosKrb5Conf

Specifica un file di configurazione Kerberos (krb5.conf) che definisce la configurazione del realm Kerberos.

Il file deve essere codificato in base 64. Se stai usando il AWS CLI, la codifica è pronta per te.

Tipo: oggetto dati binari con codifica Base64

Vincoli di lunghezza: lunghezza massima di 131072.

Obbligatorio: no

KerberosPrincipal

Speciifica un principale Kerberos, che è un'identità nell'area di autenticazione Kerberos che dispone dell'autorizzazione ad accedere a file, cartelle e metadati dei file nel file server SMB.

Potrebbe essere simile a un principale Kerberos. HOST/kerberosuser@MYDOMAIN.ORG

I nomi principali distinguono tra maiuscole e minuscole. L'esecuzione dell' DataSync attività avrà esito negativo se il principale specificato per questo parametro non corrisponde esattamente al principale utilizzato per creare il file keytab.

Tipo: String

Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 256 caratteri.

Modello: ^.+$

Obbligatorio: no

MountOptions

Speciifica la versione del protocollo SMB DataSync utilizzata per accedere al file server SMB.

Tipo: oggetto SmbMountOptions

Obbligatorio: no

Password

Speciifica la password dell'utente che può montare il file server SMB e dispone dell'autorizzazione per accedere ai file e alle cartelle coinvolti nel trasferimento. Questo parametro si applica solo se AuthenticationType è impostato su. NTLM

Tipo: String

Vincoli di lunghezza: lunghezza massima di 104.

Modello: ^.{0,104}$

Obbligatorio: no

ServerHostname

Speciifica il nome di dominio o l'indirizzo IP (IPv4 o IPv6) del file server SMB a cui l'agente si connette DataSync .

Nota

Se utilizzi l'autenticazione Kerberos, devi specificare un nome di dominio.

Tipo: String

Limitazioni di lunghezza: lunghezza massima di 255.

Modello: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

Obbligatorio: sì

Subdirectory

Speciifica il nome della condivisione esportata dal file server SMB in cui leggerà o DataSync scriverà i dati. È possibile includere una sottodirectory nel percorso di condivisione (ad esempio,). /path/to/subdirectory Assicurati che anche altri client SMB della tua rete possano montare questo percorso.

Per copiare tutti i dati nella sottodirectory, DataSync devi essere in grado di montare la condivisione SMB e accedere a tutti i suoi dati. Per ulteriori informazioni, consulta Fornire DataSync l'accesso ai file server SMB.

Tipo: String

Vincoli di lunghezza: lunghezza massima di 4096.

Modello: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

Obbligatorio: sì

Tags

Specifica le etichette che consentono di classificare, filtrare e cercare le risorse AWS . È consigliabile creare almeno un tag di nome per la posizione.

Tipo: matrice di oggetti TagListEntry

Membri dell'array: numero minimo di 0 elementi. Numero massimo di 50 item.

Obbligatorio: no

User

Speciifica l'utente che può montare e accedere ai file, alle cartelle e ai metadati dei file nel file server SMB. Questo parametro si applica solo se AuthenticationType è impostato su. NTLM

Per informazioni sulla scelta di un utente con il giusto livello di accesso per il trasferimento, consulta Fornire DataSync l'accesso ai file server SMB.

Tipo: String

Vincoli di lunghezza: lunghezza massima di 104.

Modello: ^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

Obbligatorio: no

Sintassi della risposta

{ "LocationArn": "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.

LocationArn

L'ARN della sede SMB che hai creato.

Tipo: String

Limitazioni di lunghezza: lunghezza massima di 128.

Modello: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Errori

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

InternalException

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

Codice di stato HTTP: 500

InvalidRequestException

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

Codice di stato HTTP: 400

Esempi

Richiesta di esempio

L'esempio seguente crea una posizione per un file server SMB.

{ "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs", "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3" ], "Domain":"AMAZON", "MountOptions":{ "Version":"SMB3" }, "Password":"string", "ServerHostname":"MyServer.amazon.com", "Subdirectory":"share", "Tags":[ { "Key":"department", "Value":"finance" } ], "User":"user-1" }

Risposta di esempio

Una risposta restituisce l'ARN della posizione del file server SMB.

{ "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49" }

Vedi anche

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