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

CreateLocationObjectStorage

Crea una ubicación de transferencia para un sistema de almacenamiento de objetos. AWS DataSync puede usar esta ubicación como origen o destino para transferir datos. Puede realizar transferencias con o sin un DataSyncagente.

Antes de empezar, asegúrese de entender los requisitos previos DataSync para trabajar con sistemas de almacenamiento de objetos.

Sintaxis de la solicitud

{ "AccessKey": "string", "AgentArns": [ "string" ], "BucketName": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "SecretKey": "string", "ServerCertificate": blob, "ServerHostname": "string", "ServerPort": number, "ServerProtocol": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "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.

AccessKey

Especifica la clave de acceso (por ejemplo, un nombre de usuario) si se requieren credenciales para autenticarse en el servidor de almacenamiento de objetos.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 200 caracteres.

Patrón: ^.*$

Obligatorio: no

AgentArns

(Opcional) Especifica los nombres de recursos de Amazon (ARNs) de los DataSync agentes que se pueden conectar al sistema de almacenamiento de objetos. Si está configurando una transferencia entre nubes sin agentes, no necesita especificar un valor para este parámetro.

nota

Asegúrese de configurar este parámetro correctamente la primera vez que cree su ubicación de almacenamiento. No puede añadir ni eliminar agentes de una ubicación de almacenamiento después de crearla.

Tipo: matriz de cadenas

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

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

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

Obligatorio: no

BucketName

Especifica el nombre del bucket de almacenamiento de objetos implicado en la transferencia.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 3. La longitud máxima es de 63 caracteres.

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

Obligatorio: sí

CmkSecretConfig

Especifica la información de configuración de un secreto DataSync administrado, que incluye el SecretKey que se DataSync utiliza para acceder a una ubicación de almacenamiento de objetos específica, con un secreto administrado por el cliente AWS KMS key.

Cuando incluye este parámetro como parte de una CreateLocationObjectStorage solicitud, solo proporciona la clave KMS ARN. DataSync utiliza esta clave de KMS junto con el valor que especifique para el SecretKey parámetro a fin de 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 (conSecretKey) o CustomSecretConfig (sinSecretKey) para proporcionar las credenciales para una CreateLocationObjectStorage solicitud. No proporciones ambos 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 la clave secreta de una ubicación de almacenamiento de objetos específica se almacena en texto sin formato. Esta configuración incluye el ARN secreto y el ARN de un rol de IAM que proporciona acceso al secreto.

nota

Puede utilizar CmkSecretConfig (conSecretKey) o CustomSecretConfig (sinSecretKey) para proporcionar las credenciales a una solicitud. CreateLocationObjectStorage No proporciones ambos parámetros para la misma solicitud.

Tipo: objeto CustomSecretConfig

Obligatorio: no

SecretKey

Especifica la clave secreta (por ejemplo, una contraseña) si se requieren credenciales para autenticarse en el servidor de almacenamiento de objetos.

nota

Si proporciona un secreto utilizandoSecretKey, pero no proporciona los detalles de configuración del secreto, utilizando CmkSecretConfig oCustomSecretConfig, entonces DataSync almacena el token con el secreto de Secrets Manager de su AWS cuenta.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 200 caracteres.

Patrón: ^.*$

Obligatorio: no

ServerCertificate

Especifica una cadena de certificados DataSync para autenticarse en el sistema de almacenamiento de objetos si el sistema utiliza una entidad de certificación (CA) privada o autofirmada. Debe especificar un único archivo .pem con una cadena de certificados completa (por ejemplo, file:///home/user/.ssh/object_storage_certificates.pem).

La cadena de certificados puede incluir:

  • El certificado del sistema de almacenamiento de objetos

  • Todos los certificados intermedios (si los hay)

  • El certificado raíz de la CA firmante

Puede concatenar sus certificados en un archivo .pem (que puede tener un máximo de 32 768 bytes antes de la codificación base64). El siguiente comando cat de ejemplo crea un archivo object_storage_certificates.pem que incluye tres certificados:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

Para usar este parámetro, configure el ServerProtocol para HTTPS.

Tipo: objeto de datos binarios codificados en Base64

Limitaciones de longitud: longitud máxima de 32 768 caracteres.

Obligatorio: no

ServerHostname

Especifica el nombre de dominio o la dirección IP de versión 4 (IPv4) del servidor de almacenamiento de objetos al que se conecta el DataSync agente.

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í

ServerPort

Especifica el puerto en el que el servidor de almacenamiento de objetos acepta el tráfico de red entrante (por ejemplo, el puerto 443).

Tipo: entero

Rango válido: valor mínimo de 1. Valor máximo de 65 536.

Obligatorio: no

ServerProtocol

Especifica el protocolo que usa el servidor de almacenamiento de objetos para comunicarse. Si no se especifica, el valor predeterminado es HTTPS.

Tipo: cadena

Valores válidos: HTTPS | HTTP

Obligatorio: no

Subdirectory

Especifica el prefijo de objeto del servidor de almacenamiento de objetos. Si se trata de una ubicación de origen, DataSync solo copia los objetos con este prefijo. Si se trata de una ubicación de destino, DataSync escribe todos los objetos con este prefijo.

Tipo: cadena

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

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

Obligatorio: no

Tags

Especifica el par clave-valor que representa una etiqueta que desea agregar al recurso. Las etiquetas le ayudan a administrar, filtrar y buscar sus recursos. Le recomendamos crear 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

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

Especifique el ARN de la ubicación del sistema de almacenamiento de objetos que creó.

Tipo: cadena

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

Patrón: ^arn:(aws|aws-cn|aws-us-gov|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

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, consulte lo siguiente: