CreateLocationS3

Crée un emplacement de transfert pour un compartiment Amazon S3. AWS DataSync peut utiliser cet emplacement comme source ou destination pour le transfert de données.

Important

Avant de commencer, assurez-vous de lire les rubriques suivantes :

• Considérations relatives à la classe de stockage avec les sites Amazon S3

• Évaluation des coûts des requêtes S3 lors de l'utilisation DataSync

Pour plus d'informations, consultez Configuration des transferts avec Amazon S3.

Syntaxe de la requête

{
   "AgentArns": [ "string" ],
   "S3BucketArn": "string",
   "S3Config": { 
      "BucketAccessRoleArn": "string"
   },
   "S3StorageClass": "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.

AgentArns

(Amazon S3 sur Outposts uniquement) Spécifie le nom de ressource Amazon (ARN) de l' DataSync agent sur votre Outpost.

Pour plus d'informations, consultez la section Déployer votre DataSync agent sur AWS Outposts.

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

S3BucketArn

Spécifie l'ARN du compartiment S3 que vous souhaitez utiliser comme emplacement. (Lorsque vous créerez votre DataSync tâche ultérieurement, vous indiquerez si cet emplacement est une source ou une destination de transfert.)

Si votre compartiment S3 se trouve sur une AWS Outposts ressource, vous devez spécifier un point d'accès Amazon S3. Pour plus d'informations, consultez la section Gestion de l'accès aux données avec les points d'accès Amazon S3 dans le guide de l'utilisateur Amazon S3.

Type : String

Contraintes de longueur : longueur maximale de 268.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$

Obligatoire : oui

S3Config

Spécifie le nom de ressource Amazon (ARN) du rôle AWS Identity and Access Management (IAM) DataSync utilisé pour accéder à votre compartiment S3.

Pour plus d'informations, consultez la section Fournir DataSync un accès aux compartiments S3.

Type : objet S3Config

Obligatoire : oui

S3StorageClass

Spécifie la classe de stockage que vous souhaitez que vos objets utilisent lorsque Amazon S3 est une destination de transfert.

Pour les compartiments entrants Régions AWS, la classe de stockage par défaut est. STANDARD Pour les buckets activés AWS Outposts, la classe de stockage par défaut est. OUTPOSTS

Pour plus d'informations, consultez la section Considérations relatives aux classes de stockage associées aux transferts Amazon S3.

Type : String

Valeurs valides : STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL

Obligatoire : non

Subdirectory

Spécifie un préfixe dans le compartiment S3 qui DataSync lit ou écrit vers (selon que le compartiment est un emplacement source ou de destination).

Note

DataSync Impossible de transférer des objets dont le préfixe commence par une barre oblique (/) ou inclut ///./, ou /../ des motifs. Par exemple :

• /photos

• photos//2006/January

• photos/./2006/February

• photos/../2006/March

Type : String

Contraintes de longueur : longueur maximale de 4096.

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

Obligatoire : non

Tags

Spécifie des étiquettes qui vous aident à classer, filtrer et rechercher vos AWS ressources. Nous vous recommandons de créer au moins une étiquette nominative pour votre lieu de transfert.

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

L'ARN de l'emplacement S3 que vous avez créé.

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

Exemples

Étape 1. Autoriser à assumer le rôle IAM requis pour écrire dans le compartiment

L'exemple suivant montre la politique la plus simple qui accorde les autorisations requises pour accéder AWS DataSync à un compartiment Amazon S3 de destination, suivie d'un rôle IAM auquel la create-location-s3-iam-role politique a été attachée.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "datasync.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

"Role": {
        "Path": "/",
        "RoleName": "amzn-s3-demo-bucket-access-role",
        "RoleId": "role-id",
        "Arn": "arn:aws:iam::account-id:role/amzn-s3-demo-bucket-access-role",
        "CreateDate": "2018-07-27T02:49:23.117Z",
        "AssumeRolePolicyDocument": {
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Effect": "Allow",
                    "Principal": {
                        "Service": "datasync.amazonaws.com"
                    },
                    "Action": "sts:AssumeRole"
                }
            ]
        }
    }
}

Étape 2. Autoriser le rôle IAM créé à écrire dans le bucket

Associez au rôle une politique disposant des autorisations suffisantes pour accéder au compartiment. La politique AWSDataSyncFullAccess gérée est un exemple d'une telle politique.

Pour plus d'informations, consultez AWSDataSyncFullAccessla console IAM.

Il n'est pas nécessaire de créer cette politique. Il est géré par AWS, il vous suffit donc de spécifier son ARN dans la attach-role-policy commande.

IAM_POLICY_ARN='arn:aws:iam::aws:policy/AWSDataSyncFullAccess'

Étape 3. Création d'un point de terminaison pour un compartiment Amazon S3

L'exemple suivant crée un point de terminaison pour un compartiment Amazon S3.

Lorsque le point de terminaison S3 est créé, une réponse similaire au deuxième exemple suivant renvoie le nom de ressource Amazon (ARN) du nouvel emplacement Amazon S3.

Exemple de demande

{
  "S3BucketArn": "arn:aws:s3:::amzn-s3-demo-bucket",
  "S3Config": {
     "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/amzn-s3-demo-bucket-access-role",
    },
    "S3StorageClass": "STANDARD",
    "Subdirectory": "/MyFolder",
    "Tags": [
       {
          "Key": "Name",
          "Value": "s3Bucket-1"
       }
     ]
}

Exemple de réponse

{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3"
}

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 :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• AWS SDK pour C++

• AWS SDK pour Go v2

• AWS SDK pour Java V2

• AWS SDK pour V3 JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• AWS SDK pour Ruby V3