@dathuis/serverless-s3-sync
v1.6.2
Published
A plugin to sync local directories and S3 prefixes for Serverless Framework.
Downloads
9
Readme
Serverless S3 Sync
A plugin to sync local directories and S3 prefixes for Serverless Framework :zap: .
Use Case
- Static Website (
serverless-s3-sync
) & Contact form backend (serverless
) . - SPA (
serverless
) & assets (serverless-s3-sync
) .
Install
Run npm install
in your Serverless project.
$ npm install --save serverless-s3-sync
Add the plugin to your serverless.yml file
plugins:
- serverless-s3-sync
Setup
custom:
s3Sync:
- bucketName: my-static-site-assets # required
bucketPrefix: assets/ # optional
localDir: dist/assets # required
- bucketName: my-other-site
localDir: path/to/other-site
acl: public-read # optional
followSymlinks: true # optional
defaultContentType: text/html # optional
params: # optional
- index.html:
CacheControl: 'no-cache'
- "*.js":
CacheControl: 'public, max-age=31536000'
resources:
Resources:
AssetsBucket:
Type: AWS::S3::Bucket
Properties:
BucketName: my-static-site-assets
OtherSiteBucket:
Type: AWS::S3::Bucket
Properties:
BucketName: my-other-site
AccessControl: PublicRead
WebsiteConfiguration:
IndexDocument: index.html
ErrorDocument: error.html
Usage
Run sls deploy
, local directories and S3 prefixes are synced.
Run sls remove
, S3 objects in S3 prefixes are removed.
sls s3sync
Sync local directories and S3 prefixes.