Nous avons annoncé la sortie end-of-support de la AWS SDK for JavaScript v2. Nous vous recommandons de migrer vers la AWS SDK for JavaScript version 3. Pour les dates, les détails supplémentaires et les informations sur la façon de migrer, reportez-vous à l'annonce associée.

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.

Démarrage dans Node.js

Cet exemple de code Node.js présente :

Scénario

L'exemple montre comment configurer et exécuter un module Node.js simple qui crée un compartiment Amazon S3, puis y ajoute un objet texte.

Dans la mesure où les noms de compartiment dans Amazon S3 doivent être uniques au niveau mondial, cet exemple inclut un module Node.js tiers qui génère une valeur d'ID unique que vous pouvez intégrer au nom du compartiment. Ce module supplémentaire se nomme uuid.

Tâches prérequises

Pour configurer et exécuter cet exemple, vous devez d'abord :

Étape 1 : Installation du SDK et des dépendances

Vous installez le SDK pour le JavaScript package à l'aide de npm (le gestionnaire de packages Node.js).

Depuis le répertoire awsnodesample dans le package, saisissez la commande suivante sur la ligne de commande.

npm install aws-sdk

Cette commande installe le SDK pour JavaScript dans votre projet et est mise à jour pour package.json répertorier le SDK en tant que dépendance du projet. Vous pouvez trouver des informations sur ce package en recherchant « aws-sdk » sur le site internet npm.

Installez ensuite le module uuid dans le projet en saisissant ce qui suit sur la ligne de commande. Vous installez ainsi le module et les mises à jour package.json. Pour plus d'informations sur uuid, consultez la page du module à l'adresse https://www.npmjs.com/package/uuid.

npm install uuid

Ces packages et le code associé sont installés dans le sous-répertoire node_modules de votre projet.

Pour plus d'informations sur l'installation des packages Node.js, consultez Télécharger et installer des packages localement et Créer des modules Node.js sur le site internet npm (Node.js package manager). Pour plus d'informations sur le téléchargement et l'installation du AWS SDK for JavaScript, consultezInstallation du SDK pour JavaScript.

Étape 2 : configurer vos informations d'identification

Vous devez fournir des informations d'identification pour AWS que seuls votre compte et ses ressources soient accessibles par le SDK. Pour plus d'informations sur l'obtention de vos informations d'identification, consultez Authentification du SDK avec AWS.

Pour conserver ces informations, nous vous recommandons de créer un fichier d'informations d'identification partagé. Pour savoir comment procéder, veuillez consulter la section Chargement des informations d'identification dans Node.js à partir du fichier d'informations d'identification partagé. Votre fichier d'informations d'identification doit ressembler à l'exemple suivant.

[default]
aws_access_key_id = YOUR_ACCESS_KEY_ID
aws_secret_access_key = YOUR_SECRET_ACCESS_KEY

Vous pouvez déterminer si vous avez correctement défini vos informations d'identification en exécutant le code suivant avec Node.js :

var AWS = require("aws-sdk");

AWS.config.getCredentials(function(err) {
  if (err) console.log(err.stack);
  // credentials not loaded
  else {
    console.log("Access key:", AWS.config.credentials.accessKeyId);
  }
});

De même, si vous avez correctement défini votre région dans votre config fichier, vous pouvez afficher cette valeur en attribuant à la variable d'AWS_SDK_LOAD_CONFIGenvironnement une valeur quelconque et en utilisant le code suivant :

var AWS = require("aws-sdk");

console.log("Region: ", AWS.config.region);

Étape 3 : Création du Package JSON pour le projet

Une fois que vous avez créé le répertoire de projet awsnodesample, vous créez et ajoutez un fichier package.json pour conserver les métadonnées de votre projet Node.js. Pour plus de détails sur l'utilisation package.json dans un projet Node.js, voir Création d'un fichier package.json.

Dans le répertoire du projet, créez un fichier appelé package.json. Ajoutez ce contenu JSON au fichier.

{
  "dependencies": {},
  "name": "aws-nodejs-sample",
  "description": "A simple Node.js application illustrating usage of the SDK for JavaScript.",
  "version": "1.0.1",
  "main": "sample.js",
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "NAME",
  "license": "ISC"
}

Enregistrez le fichier. Au fur et à mesure que vous installerez les modules dont vous avez besoin, la partie dependencies du fichier se complétera. Vous pouvez trouver un fichier JSON qui montre un exemple de ces dépendances ici GitHub.

Étape 4 : Écrire le code Node.js

Créez un fichier nommé sample.js pour y placer l'exemple de code. Commencez par ajouter les appels de require fonction pour inclure le SDK pour JavaScript et les uuid modules afin que vous puissiez les utiliser.

Créez un nom de compartiment unique qui sera utilisé pour créer un compartiment Amazon S3 en ajoutant une valeur d'identifiant unique à un préfixe reconnaissable, dans ce cas. 'node-sdk-sample-' Vous générez l'ID unique en appelant le module uuid. Créez ensuite un nom pour le paramètre Key utilisé pour charger un objet dans le compartiment.

Créez un objet promise pour appeler la méthode createBucket de l'objet de service AWS.S3. En cas de réponse positive, créez les paramètres requis pour charger du texte dans le compartiment que vous venez de créer. En utilisant un autre objet promise, appelez la méthode putObject pour charger l'objet de texte dans le compartiment.

// Load the SDK and UUID
var AWS = require("aws-sdk");
var uuid = require("uuid");

// Create unique bucket name
var bucketName = "node-sdk-sample-" + uuid.v4();
// Create name for uploaded object key
var keyName = "hello_world.txt";

// Create a promise on S3 service object
var bucketPromise = new AWS.S3({ apiVersion: "2006-03-01" })
  .createBucket({ Bucket: bucketName })
  .promise();

// Handle promise fulfilled/rejected states
bucketPromise
  .then(function (data) {
    // Create params for putObject call
    var objectParams = {
      Bucket: bucketName,
      Key: keyName,
      Body: "Hello World!",
    };
    // Create object upload promise
    var uploadPromise = new AWS.S3({ apiVersion: "2006-03-01" })
      .putObject(objectParams)
      .promise();
    uploadPromise.then(function (data) {
      console.log(
        "Successfully uploaded data to " + bucketName + "/" + keyName
      );
    });
  })
  .catch(function (err) {
    console.error(err, err.stack);
  });

Cet exemple de code se trouve ici sur GitHub.

Étape 5 : Exécuter l'exemple

Pour exécuter l'exemple, tapez la commande suivante.

node sample.js

Si le chargement aboutit, vous verrez un message de confirmation sur la ligne de commande. Vous pouvez également trouver le compartiment et l'objet de texte téléchargé dans la console Amazon S3.