Javascript File Upload via Put to S3
Uploading files to AWS S3 using Nodejs
AWS S3. A place where yous tin shop files. That's what nearly of you already know nearly it. S3 is 1 of the older service provided past Amazon, before the days of revolutionary Lambda functions and game irresolute Alexa Skills.Y'all tin can store most any type of files from doc to pdf, and of size ranging from 0B to 5TB.
According to their official docs, AWS S3 is,
"S3 provides comprehensive security and compliance capabilities that meet fifty-fifty the almost stringent regulatory requirements. It gives customers flexibility in the fashion they manage information for cost optimization, admission control, and compliance. " - AWS Docs
If I endeavor to put information technology in simple terms, AWS S3, is an object based storage organization where every file your store is saved as object non file. At that place are many big tech-wigs, which uses S3, and Dropbox is 1 of them. Recently, Dropbox starts saving metadata of their file in their own service simply they are nonetheless saving chief data in S3. Why? Well, S3 is not that expensive and it'southward 99.9% bachelor. Plus, you get the modify to use services similar Glacier which tin can save data and charge almost $0.01 per GB.
Then far, if I have gotten your attention, and you're thinking how to utilise S3 in my nodejs application. Well, you don't have to wait for long.
AWS has official package which exposes S3 apis for node js apps and makes it also easy for developers to access S3 from their apps.
Source: https://youtu.be/FLolHgKRTKg
In next few steps, I will guide y'all to build a nodejs based app, which can write any file to AWS S3.
1. Set upwards node app
A basic node app commonly have 2 file, package.json (for dependencies) and a starter file (like app.js, index.js, server.js).
You can use your OS's file manager or your favourite IDE to create project but I unremarkably adopt CLI. So, let's go into our shell and follow these commands:
mkdir s3-contacts-upload-demo
cd s3-contacts-upload-demo
bear upon index.js .gitignore
npm init
If you didn't get whatsoever error in higher up commands, you will have a folder by the name of s3-contacts-upload-demo, 3 files in it, package.json, .gitignore andindex.json. You lot can use this file to add file in your .gitignore file, so that these won't get committed to github or another version command.
npm init creates a package.json, which have project's details, you can just hit enter in your shell for default values if you lot wish.
2. Install dependencies
Permit'southward first by installing the NPM package:
npm install --save aws-sdk
Later successful installation of this package, you can too bank check your package.json file, information technology will accept aws-sdk listed in "dependencies" field.
This npm package tin can be used to admission any AWS service from your nodejs app, and hither we volition utilise it for S3.
iii. Import packages
Once installed, import the parcel in your lawmaking:
const fs = require('fs');
const AWS = crave('aws-sdk');
const s3 = new AWS.S3({
accessKeyId: process.env.AWS_ACCESS_KEY,
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
});
Equally y'all can find, we take likewise imported fs package which volition be used to write file data in this app. We are as well using environment variables, to fix AWS access and secret access fundamental, as it is a bad practice to put them on version control like Github or SVN.
Now, you take your S3 instance, which can access all the buckets in your AWS account.
four. Laissez passer bucket information and write business organisation logic
Below is a simple epitome of how to upload file to S3. Hither, Bucket is name of your saucepan and key is proper name of subfolder. So, if your bucket name is "test-saucepan" and you want to relieve file in "exam-bucket/folder/subfolder/file.csv", then value of Cardinal should be "older/subfolder/file.csv".
Note: S3 is object based storage and not file based. And so, even in AWS panel you can come across nested folders, behind the scene they never get saved similar that. Every object has two fields: Primal and Value. Key here is but proper name of file and Value is information which is getting stored.
So, if a bucket "bucket1" has central "key1/key2/file.mp3", you can visualize it like this:
{
"bucket1": {
"key1/key2/file.mp3": "<mp3-data>"
}
}
Below is simple snippe to upload a file,using Primal and BucketName.
const params = {
Bucket: 'bucket',
Primal: 'cardinal',
Body: stream
};
s3.upload(params, role(err, data) {
console.log(err, data);
});
v. File to upload to S3
First, create a file, permit'south say contacts.csv and write some data in it.
Higher up is some dummy data for you to get started. Now y'all take a contacts.csv file, let's read it using fs module and save information technology to S3.
S3 upload method returns error and information in callback, where information field contains location, saucepan and fundamental of uploaded file. For complete API reference, refer their official docs.
Now run this app by following control:
AWS_ACCESS_KEY=<your_access_key>
AWS_SECRET_ACCESS_KEY=<your_secret_key> node index.js
Nosotros accept passed our AWS keys equally surround variables.
If you don't get any fault in above snippet, your bucket should have the file.
And that's it, under 30 lines of code yous uploaded a file to AWS S3.
You can find the total project hither.
At that place are lot many things you can practice with this package similar
-
List out buckets and objects
-
Set permissions on saucepan
-
Create, get or delete bucket and much more
I would highly recommend you to through this doc for APIs, they are very well explained with parameters you tin can pass to each API and response format they return.
I promise you plant this mail service useful and please practise let the states know in case of any question or query.
- Node JS
Useful Links
Source: https://www.zeolearn.com/magazine/uploading-files-to-aws-s3-using-nodejs
0 Response to "Javascript File Upload via Put to S3"
إرسال تعليق