https://github.com/aws-samples/serverless-s3-uploader
AWS Serverless Application Repo example for serverless uploading to S3. Questions? @jbesw.
https://github.com/aws-samples/serverless-s3-uploader
aws lambda s3 serverless
Last synced: 3 months ago
JSON representation
AWS Serverless Application Repo example for serverless uploading to S3. Questions? @jbesw.
- Host: GitHub
- URL: https://github.com/aws-samples/serverless-s3-uploader
- Owner: aws-samples
- License: mit-0
- Created: 2020-07-15T19:51:14.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-15T19:55:04.000Z (about 5 years ago)
- Last Synced: 2025-06-05T08:20:54.023Z (4 months ago)
- Topics: aws, lambda, s3, serverless
- Language: JavaScript
- Homepage: https://aws.amazon.com/blogs/compute/author/jbeswick/
- Size: 7.81 KB
- Stars: 35
- Watchers: 7
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - aws-samples/serverless-s3-uploader - AWS Serverless Application Repo example for serverless uploading to S3. Questions? @jbesw. (JavaScript)
README
# Serverless S3 Uploader
The Serverless S3 Uploader allows you to upload JPG files to Amazon S3 buckets from your web applications using pre-signed URLs.
Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS pricing page](https://aws.amazon.com/pricing/) for details.
```bash
.
├── README.MD <-- This instructions file
├── s3UploaderFunction <-- Source code for the main lambda function
│ └── app.js <-- Main Lambda handler
│ └── testHarness.js <-- For testing code locally
│ └── package.json <-- NodeJS dependencies and scripts
├── template.yaml <-- SAM template
```
See this [YouTube video walkthrough](https://www.youtube.com/watch?v=mw_-0iCVpUc&list=PLJo-rJlep0EAY0nMNBv0MZ487l1tOFAjh&index=7) of how uploading to S3 works with presigned URLs.
## Requirements
If using outside of the AWS Serverless Application Repository:
* AWS CLI already configured with Administrator permission
* [NodeJS 12.x installed](https://nodejs.org/en/download/)
## Installation Instructions
1. [Create an AWS account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) if you do not already have one and login.
1. Go to the app's page on the [Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications/) and click "Deploy"
## Using this Application
* This application creates an API Gateway endpoint where your application can request a pre-signed URL to upload JPG objects to an S3 bucket. Once the API returns the URL, your application can PUT the object data to this URL to complete the upload.
* This application is for educational purposes and does not provide any throttling on the API Gateway endpoint. For production usage, you should [apply throttling to your API resources](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html).
* You can modify this application to upload other types of object.
## How it works
* Deploy this serverless application and take a note of the API endpoint.
* Invoke the API to receive a pre-signed URL for uploading a JPG file. Use this pre-signed URL to complete the upload.
* For a live example of this, see [this Fiddle](https://jsfiddle.net/jbeswick/Lq3vkdx2/). View the browser console to see logs of how the Fiddle is interacting with the API Gateway and presigned URL.
==============================================
Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0