Introducción a Node.js - AWS SDK for JavaScript

LaAWS SDK for JavaScript versión 3 (v3) es una reescritura de la versión 2 con algunas funciones nuevas y excelentes, incluida la arquitectura modular. Para obtener más información, consulte la Guía para desarrolladores de la versiónAWS SDK for JavaScript 3.

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.

Introducción a Node.js

JavaScript code example that applies to Node.js execution

Este ejemplo de código de Node.js muestra:

  • Cómo crear el manifiesto package.json para su proyecto.

  • Cómo instalar e incluir los módulos que su proyecto utiliza.

  • Cómo crear un objeto de servicio de Amazon Simple Storage Service (Amazon S3)AWS.S3clase cliente.

  • Cómo crear un bucket de Amazon S3 y cargar un objeto en dicho bucket.

El escenario

En el ejemplo se muestra cómo configurar y ejecutar un módulo Node.js sencillo que crea un bucket de Amazon S3 y, a continuación, le agrega un objeto de texto.

Dado que los nombres en Amazon S3 deben ser únicos de forma global, este ejemplo incluye un módulo Node.js de terceros que genera un valor de ID único que puede incorporar en el nombre de bucket. Este módulo adicional se llama uuid.

Tareas previas necesarias

Para configurar y ejecutar este ejemplo, primero debe completar estas tareas:

  • Crear un directorio de trabajo para desarrollar su módulo Node.js. Llame awsnodesample a este directorio. Tenga en cuenta que el directorio se debe crear en una ubicación donde las aplicaciones lo puedan actualizar. Por ejemplo, en Windows, no cree el directorio en la sección "C:\Archivos de programa".

  • Instale Node.js. Para obtener más información, consulte el sitio web de Node.js. Puede encontrar descargas de las versiones LTS y actual de Node.js para una serie de sistemas operativos en https://nodejs.org/en/download/current/.

Paso 1: Instalación del SDK y las dependencias

El paquete SDK for JavaScript se instala utilizandonpm (el administrador de paquetes Node.js).

En el directorio awsnodesample del paquete, escriba lo siguiente en la línea de comandos.

npm install aws-sdk

Este comando instala el SDK de para JavaScript en su proyecto y actualizapackage.jsonpara incluir el SDK como dependencia de un proyecto. Puede encontrar información sobre este paquete buscando "aws-sdk" en el sitio web de npm.

A continuación, instale el módulo uuid en el proyecto escribiendo lo siguiente en la línea de comandos, para instalar el módulo y las actualizaciones package.json. Para obtener más información acerca de uuid, consulte la página del módulo en https://www.npmjs.com/package/uuid.

npm install uuid

Estos paquetes y su código asociado se instalan en el subdirectorio node_modules del proyecto.

Para obtener más información acerca de la instalación de paquetes Node.js, consulte las secciones sobre cómo descargar e instalar paquetes locales y cómo crear módulos Node.js en el sitio web de npm (administrador de paquetes de Node.js). Para obtener información acerca del cómo descargar e instalar el AWS SDK for JavaScript, consulte Instalación del SDK para JavaScript.

Paso 2: Configurar sus credenciales de

Debe proporcionar credenciales deAWSDe modo que el SDK solo obtenga acceso a su cuenta y sus recursos. Para obtener más información sobre cómo obtener sus credenciales de cuenta, consulte Obtención de las credenciales.

Para almacenar esta información, le recomendamos que cree un archivo de credenciales compartidas. Para saber cómo hacerlo, consulte Carga de credenciales en Node.js desde el archivo de credenciales compartidas. Su archivo de credenciales debe parecerse al siguiente ejemplo.

[default] aws_access_key_id = YOUR_ACCESS_KEY_ID aws_secret_access_key = YOUR_SECRET_ACCESS_KEY

Puede determinar si ha configurado sus credenciales correctamente ejecutando el siguiente código con node:

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); } });

Del mismo modo, si ha definido la región correctamente en el archivo config, puede mostrar ese valor estableciendo la variable de entorno AWS_SDK_LOAD_CONFIG en un valor verdadero y utilizando el siguiente código:

var AWS = require("aws-sdk"); console.log("Region: ", AWS.config.region);

Paso 3: Creación del JSON de paquete para el proyecto

Después de crear el directorio del proyecto awsnodesample, debe crear y añadir un archivo package.json para guardar los metadatos de su proyecto de Node.js. Para obtener información detallada acerca de cómo utilizar package.json en un proyecto Node.js, consulte la sección sobre qué es el archivo package.json.

En el directorio del proyecto, cree un archivo nuevo denominado package.json. Luego añada este JSON al archivo.

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

Guarde el archivo. A medida que instale los módulos que necesita, la parte dependencies del archivo se completará. Puede encontrar un archivo JSON que muestra un ejemplo de estas dependencias aquí, en GitHub.

Paso 4: Escriba el código Node.js

Cree un archivo nuevo denominado sample.js para que contenga el código de ejemplo. Comience añadiendo elrequirellamadas de función para incluir el SDK de para JavaScript yuuidmódulos de modo que estén disponibles para que los use.

Cree un nombre de bucket único que se utilice para crear un bucket de Amazon S3 añadiendo un valor de ID único a un prefijo fácil de reconocer, en este caso'node-sdk-sample-'. Puede generar el ID único llamando al módulo uuid. A continuación, cree un nombre para el parámetro Key utilizado para cargar un objeto en el bucket.

Cree un objeto promise para llamar al método createBucket del objeto de servicio AWS.S3. Si obtiene una respuesta correcta, cree los parámetros necesarios para cargar texto al bucket que acaba de crear. Usando otra promesa, llame al método putObject para cargar el objeto de texto en el bucket.

// 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); });

Este código de muestra se puede encontrar aquí en GitHub.

Paso 5: Ejecute el ejemplo

Escriba el comando siguiente para ejecutar el ejemplo.

node sample.js

Si la carga se realiza correctamente, verá un mensaje de confirmación en la línea de comandos. También puede encontrar el bucket y el objeto de texto cargado en la consola de Amazon S3.