How to upload file to s3 in Node.js?

If you are working on a Node.js project that requires file storage, Amazon S3 (Simple Storage Service) is an ideal solution. S3 provides a scalable, secure, and highly available way to store and retrieve files. In this article, we will guide you through the steps to configure an S3 bucket in a Node.js project.

Creating an S3 Bucket

The first step in configuring an S3 bucket is to create one. Follow these steps to create an S3 bucket:

Log in to the AWS Management Console.
Navigate to the S3 service.
Click on the “Create bucket” button.
Enter a unique name for your bucket.
Select a region for your bucket.
Click on the “Create” button.

Creating an AWS IAM User

To access your S3 bucket from a Node.js project, you will need to create an AWS IAM (Identity and Access Management) user with the appropriate permissions. Follow these steps to create an IAM user:

Log in to the AWS Management Console.
Navigate to the IAM service.
Click on the “Users” menu item.
Click on the “Add user” button.
Enter a name for your user.
Select “Programmatic access” as the access type.
Click on the “Next: Permissions” button.
Select “Attach existing policies directly” as the permissions type.
Select the “AmazonS3FullAccess” policy.
Click on the “Next: Tags” button.
Click on the “Next: Review” button.
Click on the “Create user” button.
Save the access key ID and secret access key for your user.

Configuring AWS Credentials

Next, you need to configure your AWS credentials in your Node.js project. Follow these steps to configure your credentials:

Install the AWS CLI (Command Line Interface) on your machine.
Open a command prompt and run the command “aws configure”.
Enter your access key ID and secret access key.
Enter the default region for your bucket.
Enter “json” as the default output format.

Installing the AWS SDK for Node.js

To interact with your S3 bucket from a Node.js project, you will need to install the AWS SDK (Software Development Kit) for Node.js. Follow these steps to install the AWS SDK:

Open a command prompt in your project directory.
Run the command “npm install aws-sdk”.

Uploading a File to S3

To upload a file to your S3 bucket from a Node.js project, you can use the AWS SDK’s “putObject” method. Here’s an example code snippet:

const AWS = require('aws-sdk');
const fs = require('fs');

const s3 = new AWS.S3();

const uploadFile = (fileName) => {
  const fileContent = fs.readFileSync(fileName);

  const params = {
    Bucket: 'your-bucket-name',
    Key: 'example-file.jpg',
    Body: fileContent
  };

  s3.upload(params, (err, data) => {
    if (err) {
      throw err;
    }
    console.log(`File uploaded successfully. ${data.Location}`);
  });
};

uploadFile('example-file.jpg');

This code uses the fs module to read the contents of a file and the s3.upload method to upload it to the S3 bucket. You need to replace the your-bucket-name value in the params object with the name of your S3 bucket.

Retrieving a File from S3

To retrieve a file from your S3 bucket, you can use the AWS SDK’s getObject method. Here’s an example code snippet:

const AWS = require('aws-sdk');

const s3 = new AWS.S3();

const getFile = () => {
  const params = {
    Bucket: 'your-bucket-name',
    Key: 'example-file.jpg'
  };

  s3.getObject(params, (err, data) => {
    if (err) {
      throw err;
    }
    console.log(`File retrieved successfully. ${data.Body.toString()}`);
  });
};

getFile();

This code uses the s3.getObject method to retrieve the contents of a file from the S3 bucket. You need to replace the your-bucket-name value in the params object with the name of your S3 bucket.

Deleting a File from S3

To delete a file from your S3 bucket, you can use the AWS SDK’s deleteObject method. Here’s an example code snippet:

const AWS = require('aws-sdk');

const s3 = new AWS.S3();

const deleteFile = () => {
  const params = {
    Bucket: 'your-bucket-name',
    Key: 'example-file.jpg'
  };

  s3.deleteObject(params, (err, data) => {
    if (err) {
      throw err;
    }
    console.log(`File deleted successfully. ${data}`);
  });
};

deleteFile();

This code uses the s3.deleteObject method to delete a file from the S3 bucket. You need to replace the your-bucket-name value in the params object with the name of your S3 bucket.

Enabling CORS for S3

If you want to allow cross-origin resource sharing (CORS) for your S3 bucket, you need to configure CORS rules. Follow these steps to configure CORS rules for your S3 bucket:

Log in to the AWS Management Console.
Navigate to the S3 service.
Click on the name of your bucket.
Click on the “Permissions” tab.
Click on the “CORS configuration” button.
Add the following XML code to the editor:

<CORSConfiguration>
  <CORSRule>
    <AllowedOrigin>*</AllowedOrigin>
    <AllowedMethod>GET</AllowedMethod>
    <MaxAgeSeconds>3000</MaxAgeSeconds>
    <AllowedHeader>*</AllowedHeader>
  </CORSRule>
</CORSConfiguration>

Conclusion

Using S3 in your Node.js project can be a great way to store and manage your files. It provides you with a scalable and reliable way to store and retrieve data, and it can help you reduce your infrastructure costs.

Thank You