Postman File Upload to Aws From Pre Signed Post

How to Upload a Binary File to Amazon S3 Bucket using Pre-Signed URL

I take seen many people are facing an issue in uploading a binary file from their Balance API to the Amazon S3 Bucket. In every web and mobile application, it's common and good to provide users with the characteristic of upload binary files such as PDFs, Images, Videos, GIFs, etc to the S3 Bucket of our application.

Normally, all server-based applications or server-side technologies are providing this kind of facility, only commonly, binary files are quite larger than text-based files, and so the upload procedure of binary files may accept upwards network I/O and CPU time of your server. And in these cases, you need to go on track of the state transfer of the upload process — whether it failed, succeeded or needs to be re-uploaded.

In the terminate, the result of these types of processes may take your application down or consequence in a late response in case of high traffic on your applications. So finally, your customers might exist unhappy.

So you might have the question — is it possible to avert proxy of those requests through your awarding server or is there any serverless solution for this?

Yes, in that location is one serverless solution: you can upload your binary file directly to the Amazon S3 Bucket. In this blog, I am going to testify how you can upload a binary file into your S3 Saucepan.

Architecture

To practise this, there is a elementary one architecture and I accept divided that architecture in 2 small part,

Start function of architecture A in the API Gateway will receive GET request from the user, Go method of API Gateway is integrated with lambda function, so API Gateway volition pass that GET Request to Lambda function and Lambda function will call the S3 Bucket using method of AWS SDK(i.e. In JavaScript SDK(NodeJS), using getSignedUrl() or getSignedUrlPromise()). and lambda volition send dorsum response with S3 Pre-SignedUrl to API Gateway and API Gateway to User.

Second role of compages B, once application got Pre-signedUrl then application can perform PUT request on that URL to upload binary file earlier expiry of pre-signedurl.

I will show implementation of this concept using two methods

1. Using AWS Serverless Application Modal(SAM) template
2. From AWS Console

Using AWS SAM Template

First, install AWS SAM CLI on your machine, you can find installation steps from official documentation of AWS SAM,

Git Repository: https://github.com/ParthTrambadiya/binary-file-upload-s3

Clone AWS SAM Template from my GitHub Repository, and perform below commands.

          cd binary-file-upload-s3        

To build SAM Template

          sam build        

To deploy cloudformation stack on AWS

          sam deploy --guided        

if you lot have set multiple profile of AWS IAM users and you want to deploy in one specific profile'southward AWS Account:

          sam deploy --guided --profile <contour-name>        

Note: In Lambda part of this stack(y'all will find lambda function code under functions folder of git repo, upload.js ), must change ContentType according your application. For reference see this:

If you desire don't to see implementation using AWS Console then you tin can directly jump on Test role of this commodity.

From AWS Panel

First, login or signup into your AWS Console, and go to S3.

Create a new S3 bucket by clicking on Create bucket , your bucket must be unique globally, bucket names must be between 3 and 63 characters long, bucket names can consist merely of lowercase letters, numbers, dots (.), and hyphens (-), bucket names must begin and end with a letter or number, bucket names must not be formatted equally an IP address (for instance, 192.168.5.4). For more information about Bucket Naming Dominion visit below link:

Choose saucepan region co-ordinate your project, and get out all other options as it is or default just for demo purpose or you tin can alter according your requirements, and now click on Create saucepan push button.

After creation of Amazon S3 Bucket go to AWS Lambda Function.

Create a new lambda function from Orangish push button "Create Function" at top-right corner, in creation of lambda function choose Writer From Scratch .

In basic information, write Part name , according your requirements, Runtime , choose latest version of NodeJS(i.e. Node.Js xiv.x). Now leave all other options default and click on Create Function .

Once you lot accept created office, copy and paste below code into newly created lambda function.

You have created S3 bucket, and then go and go proper noun of bucket which you created in in a higher place step and write or paste at Saucepan option in s3Params.

Note: In Lambda function, must modify ContentType according your application. For reference run into this:

At the our s3Pramas will look like below, in our instance.

          const s3Params = {          Bucket: binary-file-upload-saucepan-parth,          Central,          Expires: 300,          ContentType: 'video/mp4',          }        

We have configured our lambda role, but we demand to give permission to lambda to access our s3 bucket.

Now go to Configuration tab of lambda function and click on permission tab at left side bar, and in Execution Part section click on office name, so yous volition redirect to IAM Console.

On IAM Panel click on attach policies under permission tab, and search AWS Managed Policy AmazonS3FullAccess and attach this policy to that IAM Role.

Now go to API Gateway,

Create Residuum API by clicking on Build button of REST API menu.

In Protocol cull REST, we are creating new API so choose new API , and in setting write API name according to your projection and Endpoint Blazon Cull Regional , you can also cull Edge-Optimized of you want. For more data nearly Endpoint visit beneath link:

In resource, create other sub resource with upload proper noun from action button and click on create resource.

Resources Proper noun: upload

Resource Path: upload

Click on create resource.

Click on /upload resource and so click on action button and create method.

Choose Get method and click on push button with right sign.

One time you have crated GET method then go to inside that method. yous will run across this kind of screen.

In Integration Blazon , choose Lambda function, in Lambda Region choose AWS region where your lambda part is available, and in Lambda Function type lambda role name(which we created in to a higher place step) and select from menu. Now click on Relieve.

It will enquire for above permission, so click on Ok.

Now click over again on /upload resource and then click on action, and and so click on Enable CORS .

In Accecc-Control-Let-Headers remove all existing content and blazon simply '*' and get out other pick default and click on Enable CORS and supplant… button, and then press on Yes, replace existing values.

Now click on your root resource / then click on that Action button and choose Deploy API fill-upwards all details and click on Deploy, now will get endpoint of this API.

          https://api-id.execute-api.aws-region.amazonaws.com/dev        

So, now you lot have configured all setup, at present this plow of testing, I am going to show yous API testing past Postman . Postman is a collaboration platform for API development. Postman's features simplify each step of building an API and streamline collaboration and then you can create better APIs — faster.

Testing

Starting time, get your API Endpoint from API Gateway Panel and append your resources proper name into that endpoint so your API endpoint will look likes,

          https://api-id.execute-api.aws-region.amazonaws.com/dev/upload        

Now go to Postman Desktop Awarding and create Go Method and copy and paste higher up endpoint in postman, which look likes,

At present fire the asking by clicking on Send button, if you take configured perfectly as I shown yous then you will get Success response from API.

In body part of success response you will become s3 pre-signedurl for putObject and information technology will valid for next Ten minutes that yous accept written in your lambda lawmaking.

Now re-create and that URL only and create new PUT method in postman, and paste in URL. In Body tab cull binary and select binary file from your machine.

And now fire request by clicking on Send button, it will accept time based on size of your binary file.

If y'all go condition: 200 that means your binary file is successfully uploaded in S3 bucket, and so you tin can check in Amazon S3.

And then, that's it. Thanks for reading, and please follow and tell me other issues you may have faced or are facing then that I can create a solution for those problems as well.

More content at plainenglish.io

ryansendes.blogspot.com

Source: https://aws.plainenglish.io/how-you-can-upload-binary-file-to-amazon-s3-bucket-via-api-gateway-f12c11d2b365

Share this post