Setting up S3 region and buckets usage for AWS S3 storage

This topic covers the necessary setup needed for a Storage Connector 3.x regions and buckets usage, when Amazon S3 is used as a storage type. 

Depending on whether you are making path-style or virtual hosted-style requests to your buckets, the configuration of the Storage Connector will differ.

Types of Syncplicity buckets

The properties for all storage types have the following format: syncplicity.storage.<storage_type_name>.<bucket_name>.<property_name>.  

bucket_name is optional and can be:

• data - the files you keep in your storage
• image - thumbnails (previews) of image files
• irm - IRM data, for use when Rights Management is enabled. 
• archive - zip archives created during bulk download requests

The reason we separate those is because preview (image) and irm files are temporary operation files. Having them separated allows you to track your storage much better and backup only essential data. 

Code samples

Virtual host-type requests

For virtual host-type requests you can either identify the bucket location by specifying the region or the URL itself. 

Example with region

syncplicity:
    crypto.keyStore.enforced: false
    ws:
        accesskey: SV_ACCESS_KEY
        url: XML_SERVICE_URL
    storage:
        type: s3
        s3:
            access: ABCDEFG1HIJ23KLMNOPQ
            secret: a1B2cdeF3GhIjklmN/OP45q+rstuvwX67yZ12345
            bucket: my_bucket
            region: us-east-1

Example with URL

syncplicity:
    crypto.keyStore.enforced: false
    ws:
        accesskey: SV_ACCESS_KEY
        url: XML_SERVICE_URL
    storage:
        type: s3
        s3:
            access: ABCDEFG1HIJ23KLMNOPQ
            secret: a1B2cdeF3GhIjklmN/OP45q+rstuvwX67yZ12345
            bucket: my_bucket
            url: s3-external-1.amazonaws.com

Path-style requests

To enable path-style access to the S3 storage, you need to set the syncplicity.storage.s3.pathStyleAccess parameter to true. Access is achieved by specifying the bucket name and URL.

Example for path-style access

syncplicity:
    crypto.keyStore.enforced: false
    ws:
        accesskey: SV_ACCESS_KEY
        url: XML_SERVICE_URL
    storage:
        type: s3
        s3:
            pathStyleAccess: true
            access: ABCDEFG1HIJ23KLMNOPQ
            secret: a1B2cdeF3GhIjklmN/OP45q+rstuvwX67yZ12345
            bucket: my_bucket
            url: s3-external-1.amazonaws.com