CreateLocationSmb - AWS DataSync

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateLocationSmb

Crea una ubicación de transferencia para un servidor de archivos de bloque de mensajes del servidor (SMB). AWS DataSync puede usar esta ubicación como origen o destino para transferir datos.

Antes de empezar, asegúrese de entender cómo se DataSync accede a los servidores de archivos SMB. Para obtener más información, consulte Proporcionar DataSync acceso a los servidores de archivos SMB.

Sintaxis de la solicitud

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

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

AgentArns

Especifica el DataSync agente (o los agentes) que se pueden conectar al servidor de archivos SMB. Puede especificar un agente mediante un nombre de recurso de Amazon (ARN).

Tipo: matriz de cadenas

Miembros de la matriz: número mínimo de 1 artículo. La cantidad máxima es de 8 elementos.

Limitaciones de longitud: longitud máxima de 128 caracteres.

Patrón: ^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}$

Obligatorio: sí

AuthenticationType

Especifica el protocolo de autenticación que se DataSync utiliza para conectarse al servidor de archivos SMB. DataSync el soporte NTLM (predeterminado) y la KERBEROS autenticación.

Para obtener más información, consulte Proporcionar DataSync acceso a servidores de archivos SMB.

Tipo: cadena

Valores válidos: NTLM | KERBEROS

Obligatorio: no

CmkSecretConfig

Especifica la información de configuración de un secreto DataSync administrado, ya sea a Password o KerberosKeytab (para los tipos de KERBEROS autenticación NTLM (predeterminado) y, respectivamente,) que se DataSync utiliza para acceder a una ubicación de almacenamiento SMB específica, con una ubicación administrada por el cliente. AWS KMS key

Cuando incluye este parámetro como parte de una CreateLocationSmbRequest solicitud, solo proporciona la clave KMS ARN. DataSync utiliza esta clave de KMS junto con la clave Password o bien la KerberosKeytab que usted especifique para crear un secreto DataSync administrado para almacenar las credenciales de acceso a la ubicación.

Asegúrese de que DataSync tiene permiso para acceder a la clave de KMS que especifique.

nota

Puede usar CmkSecretConfig (con Password oKerberosKeytab) o CustomSecretConfig (sin ningún Password yKerberosKeytab) para proporcionar las credenciales para una CreateLocationSmbRequest solicitud. No proporciones ambos CmkSecretConfig CustomSecretConfig parámetros para la misma solicitud.

Tipo: objeto CmkSecretConfig

Obligatorio: no

CustomSecretConfig

Especifica la información de configuración de un secreto de Secrets Manager administrado por el cliente donde las credenciales de la ubicación de almacenamiento SMB se almacenan en Secrets Manager como texto sin formato (paraPassword) o binarias (para). KerberosKeytab Esta configuración incluye el ARN del secreto y el ARN de un rol de IAM que proporciona acceso al secreto.

nota

Puede usar CmkSecretConfig (con SasConfiguration) o CustomSecretConfig (sin SasConfiguration) para proporcionar credenciales para una solicitud CreateLocationSmbRequest. No proporcione ambos parámetros para la misma solicitud.

Tipo: objeto CustomSecretConfig

Obligatorio: no

DnsIpAddresses

Especifica las IPv6 direcciones IPv4 o de los servidores DNS a los que pertenece el servidor de archivos SMB. Este parámetro se aplica únicamente si AuthenticationType se establece en KERBEROS.

Si tiene varios dominios en su entorno, la configuración de este parámetro garantiza que DataSync se conecte al servidor de archivos SMB correcto.

Tipo: matriz de cadenas

Miembros de la matriz: número máximo de 2 elementos.

Limitaciones de longitud: longitud mínima de 7. Longitud máxima de 39.

Patrón: \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

Obligatorio: no

Domain

Especifica el nombre de dominio de Windows al que pertenece el servidor de archivos SMB. Este parámetro se aplica únicamente si AuthenticationType se establece en NTLM.

Si tiene varios dominios en su entorno, la configuración de este parámetro garantiza que DataSync se conecte al servidor de archivos correcto.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 253 caracteres.

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

Obligatorio: no

KerberosKeytab

Especifica el archivo de tabla de claves de Kerberos (keytab), que incluye las asignaciones entre la entidad principal de Kerberos y las claves de cifrado.

Para evitar errores durante la ejecución de tareas, asegúrese de que la entidad principal de Kerberos que utiliza para crear el archivo keytab coincida exactamente con lo que especifica para KerberosPrincipal.

Tipo: objeto de datos binarios codificados en Base64

Limitaciones de longitud: longitud máxima de 65 536 caracteres.

Obligatorio: no

KerberosKrb5Conf

Especifica un archivo de configuración de Kerberos (krb5.conf) que define la configuración del dominio Kerberos.

El archivo debe estar codificado en base64. Si está utilizando el AWS CLI, la codificación está lista para usted.

Tipo: objeto de datos binarios codificados en Base64

Limitaciones de longitud: longitud máxima de 131 072 caracteres.

Obligatorio: no

KerberosPrincipal

Especifica una entidad principal de Kerberos, que es una identidad en el dominio de Kerberos con permiso para acceder a los archivos, las carpetas y los metadatos de archivos en el servidor de archivos SMB.

Una entidad principal de Kerberos puede tener un formato similar a HOST/kerberosuser@MYDOMAIN.ORG.

Los nombres de las entidades principales distinguen entre mayúsculas y minúsculas. La ejecución de la DataSync tarea fallará si el principal que especifique para este parámetro no coincide exactamente con el principal que utilizó para crear el archivo keytab.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.

Patrón: ^.+$

Obligatorio: no

MountOptions

Especifica la versión del protocolo SMB que se DataSync utiliza para acceder al servidor de archivos SMB.

Tipo: objeto SmbMountOptions

Obligatorio: no

Password

Especifica la contraseña del usuario que puede montar su servidor de archivos SMB y que tiene permiso para acceder a los archivos y las carpetas involucrados en la transferencia. Este parámetro se aplica únicamente si AuthenticationType se establece en NTLM.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 104 caracteres.

Patrón: ^.{0,104}$

Obligatorio: no

ServerHostname

Especifica el nombre de dominio o la dirección IP (IPv4 o IPv6) del servidor de archivos SMB al que se conecta el DataSync agente.

nota

Si utiliza autenticación Kerberos, debe especificar un nombre de dominio.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 255 caracteres.

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

Obligatorio: sí

Subdirectory

Especifica el nombre del recurso compartido exportado por el servidor de archivos SMB en el que se DataSync leerán o escribirán los datos. Puede incluir un subdirectorio en la ruta del recurso compartido (por ejemplo, /path/to/subdirectory). Asegúrese de que otros clientes de SMB de la red también puedan montar esta ruta.

Para copiar todos los datos del subdirectorio, DataSync debe poder montar el recurso compartido SMB y acceder a todos sus datos. Para obtener más información, consulte Proporcionar DataSync acceso a los servidores de archivos SMB.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 4096 caracteres.

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

Obligatorio: sí

Tags

Especifica las etiquetas que le ayudan a clasificar, filtrar y buscar sus recursos de AWS . Le recomendamos crear al menos una etiqueta de nombre para su ubicación.

Tipo: matriz de objetos TagListEntry

Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 50 artículos.

Obligatorio: no

User

Especifica el usuario que puede montar y acceder a los archivos, carpetas y metadatos del servidor de archivos de SMB. Este parámetro se aplica únicamente si AuthenticationType se establece en NTLM.

Para obtener información sobre cómo elegir un usuario con el nivel de acceso adecuado para la transferencia, consulte Proporcionar DataSync acceso a los servidores de archivos SMB.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 104 caracteres.

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

Obligatorio: no

Sintaxis de la respuesta

{ "LocationArn": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

LocationArn

El ARN de la ubicación de SMB que creó.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 128 caracteres.

Patrón: ^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}$

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalException

Esta excepción se produce cuando se genera un error en el servicio AWS DataSync .

Código de estado HTTP: 500

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

Código de estado HTTP: 400

Ejemplos

Solicitud de ejemplo

En el siguiente ejemplo, se crea una ubicación para un sistema de archivos 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" }

Respuesta de ejemplo

Una respuesta devuelve el ARN de ubicación de su servidor de archivos SMB.

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

Véase también

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente: