CreateLocationObjectStorage - AWS DataSync
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CreateLocationObjectStorage

Crée un emplacement de transfert pour un système de stockage d'objets. AWS DataSync peut utiliser cet emplacement comme source ou destination pour le transfert de données. Vous pouvez effectuer des virements avec ou sans DataSyncagent.

Avant de commencer, assurez-vous de connaître les prérequis pour travailler avec DataSync les systèmes de stockage d'objets.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

Cette demande accepte les données suivantes au format JSON.

AccessKey

Spécifie la clé d'accès (par exemple, un nom d'utilisateur) si des informations d'identification sont requises pour s'authentifier auprès du serveur de stockage d'objets.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 200.

Modèle : ^.*$

Obligatoire : non

AgentArns

(Facultatif) Spécifie les Amazon Resource Names (ARNs) des DataSync agents qui peuvent se connecter à votre système de stockage d'objets. Si vous configurez un transfert cross-cloud sans agent, il n'est pas nécessaire de spécifier une valeur pour ce paramètre.

Note

Assurez-vous de configurer correctement ce paramètre lorsque vous créez votre emplacement de stockage pour la première fois. Il est impossible d'ajouter ou de supprimer des agents d'un emplacement de stockage après l'avoir créé.

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 4 articles.

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^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}$

Obligatoire : non

BucketName

Spécifie le nom du compartiment de stockage d'objets impliqué dans le transfert.

Type : String

Contraintes de longueur : Longueur minimum de 3. Longueur maximum de 63.

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

Obligatoire : oui

CmkSecretConfig

Spécifie les informations de configuration pour un secret DataSync géré, notamment le SecretKey secret DataSync utilisé pour accéder à un emplacement de stockage d'objets spécifique, avec un secret géré par le client AWS KMS key.

Lorsque vous incluez ce paramètre dans le cadre d'une CreateLocationObjectStorage demande, vous ne fournissez que l'ARN de la clé KMS. DataSync utilise cette clé KMS avec la valeur que vous spécifiez pour le SecretKey paramètre afin de créer un secret DataSync géré afin de stocker les informations d'identification d'accès à la localisation.

Assurez-vous qu' DataSync il est autorisé à accéder à la clé KMS que vous spécifiez.

Note

Vous pouvez utiliser CmkSecretConfig (avecSecretKey) ou CustomSecretConfig (sansSecretKey) pour fournir des informations d'identification pour une CreateLocationObjectStorage demande. Ne fournissez pas les deux paramètres pour la même demande.

Type : objet CmkSecretConfig

Obligatoire : non

CustomSecretConfig

Spécifie les informations de configuration pour un secret du Gestionnaire de Secrets Manager géré par le client dans lequel la clé secrète d'un emplacement de stockage d'objets spécifique est stockée en texte brut. Cette configuration inclut l'ARN secret et l'ARN d'un rôle IAM qui donne accès au secret.

Note

Vous pouvez utiliser CmkSecretConfig (avecSecretKey) ou CustomSecretConfig (sansSecretKey) pour fournir des informations d'identification pour une CreateLocationObjectStorage demande. Ne fournissez pas les deux paramètres pour la même demande.

Type : objet CustomSecretConfig

Obligatoire : non

SecretKey

Spécifie la clé secrète (par exemple, un mot de passe) si des informations d'identification sont requises pour s'authentifier auprès du serveur de stockage d'objets.

Note

Si vous fournissez un code secret en utilisant CmkSecretConfig ouSecretKey, si vous ne fournissez pas de détails de configuration secretsCustomSecretConfig, vous DataSync stockez le jeton en utilisant le secret du Gestionnaire de Secrets Manager de votre AWS compte.

Type : String

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 200.

Modèle : ^.*$

Obligatoire : non

ServerCertificate

Spécifie une chaîne de certificats DataSync pour l'authentification auprès de votre système de stockage d'objets si celui-ci utilise une autorité de certification (CA) privée ou auto-signée. Vous devez spécifier un seul .pem fichier avec une chaîne de certificats complète (par exemple,file:///home/user/.ssh/object_storage_certificates.pem).

La chaîne de certificats peut inclure :

  • Le certificat du système de stockage d'objets

  • Tous les certificats intermédiaires (s'il y en a)

  • Le certificat racine de l'autorité de certification signataire

Vous pouvez concaténer vos certificats dans un .pem fichier (dont la taille peut atteindre 32 768 octets avant le codage base64). L'exemple de cat commande suivant crée un object_storage_certificates.pem fichier contenant trois certificats :

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

Pour utiliser ce paramètre, configurez ServerProtocol surHTTPS.

Type : objet de données binaires encodées en base64

Contraintes de longueur : longueur maximale de 32 768.

Obligatoire : non

ServerHostname

Spécifie le nom de domaine ou l'adresse IP version 4 (IPv4) du serveur de stockage d'objets auquel votre DataSync agent se connecte.

Type : String

Contraintes de longueur : longueur maximale de 255.

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

Obligatoire : oui

ServerPort

Spécifie le port sur lequel votre serveur de stockage d'objets accepte le trafic réseau entrant (par exemple, le port 443).

Type : entier

Plage valide : valeur minimum de 1. Valeur maximale de 65536.

Obligatoire : non

ServerProtocol

Spécifie le protocole utilisé par votre serveur de stockage d'objets pour communiquer. L'échelle par défaut, si elle n'est pas spécifiée, est de HTTPS.

Type : String

Valeurs valides : HTTPS | HTTP

Obligatoire : non

Subdirectory

Spécifie le préfixe d'objet pour votre serveur de stockage d'objets. S'il s'agit d'un emplacement source, copie DataSync uniquement les objets portant ce préfixe. S'il s'agit d'un emplacement de destination, DataSync écrit tous les objets avec ce préfixe.

Type : String

Contraintes de longueur : longueur maximale de 4096.

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

Obligatoire : non

Tags

Spécifie la paire clé-valeur qui représente une balise que vous souhaitez ajouter à la ressource. Les balises vous aident à gérer, filtrer et rechercher vos ressources. Nous vous recommandons de créer une balise de nom pour votre emplacement.

Type : tableau d’objets TagListEntry

Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments.

Obligatoire : non

Syntaxe de la réponse

{
   "LocationArn": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

LocationArn

Spécifie l'ARN de l'emplacement du système de stockage d'objets que vous créez.

Type : String

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^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}$

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InternalException

Cette exception est levée lorsqu'une erreur se produit dans le AWS DataSync service.

Code d’état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :