serverless-s3bucket-sync
v0.1.5
Published
Serverless Plugin to sync local folders with an S3 bucket
Downloads
120
Maintainers
Readme
⚡️ Serverless Plugin for S3 Sync
With this plugin for serverless, you can sync local folders to S3 buckets after your service is deployed.
Usage
Add the NPM package to your project:
# Via yarn
$ yarn add serverless-s3bucket-sync
# Via npm
$ npm install serverless-s3bucket-sync
Add the plugin to your serverless.yml
:
plugins:
- serverless-s3bucket-sync
Configuration
Configure S3 Bucket syncing Auto Scaling in serverless.yml
with references to your local folder and the name of the S3 bucket.
custom:
s3-sync:
- folder: relative/folder
bucket: bucket-name
That's it! With the next deployment, serverless will sync your local folder relative/folder
with the S3 bucket named bucket-name
.
Sync
You can use sls sync
to synchornize all buckets without deploying your serverless stack.
License
Feel free to use the code, it's released using the MIT license.
Contribution
You are welcome to contribute to this project! 😘
To make sure you have a pleasant experience, please read the code of conduct. It outlines core values and beliefs and will make working together a happier experience.