FLUTTER ECOSYSTEM

Serdnad/aws_s3_upload

A simple, convenient package for uploading to S3 in Flutter

aws_s3_upload project cover
Stars
16
Forks
66
Last push (UTC)
Aug 20, 2024
Project status
Active
Andres Gutierrez GitHub avatar
GITHUB User

Andres Gutierrez ↗

San Francisco
LanguagesDart

Packages published by this repository

Dependencies used

Dependency list 6 items

Original README

English project snapshot. Visit GitHub for the latest content.

Expand / collapse project README

aws_s3_upload

A simple, convenient package for uploading to S3.

Heavily inspired by this stackoverflow answer

Getting Started

Having created credentials on AWS, upload a file like so:

AwsS3.uploadFile(
  accessKey: "AKxxxxxxxxxxxxx",
  secretKey: "xxxxxxxxxxxxxxxxxxxxxxxxxx",
  file: File("path_to_file"),
  bucket: "bucket_name",
  region: "us-east-2",
  metadata: {"test": "test"} // optional
);

Warning

Before using this package, consider if it's acceptable to include AWS keys in your final app. Doing so might be okay for internal or trusted apps, but think twice before including keys in an app published on the app store.

Motivation / Disclaimer

There already exists a number of Flutter plugins for interacting with S3, some of which are more actively maintained. This small library was built because the few I tried either failed to work out of the box, or required the use of a Pool ID and AWS Cognito, which my project doesn't use. YMMV.