Amazon S3 Snapshot Store Plugin for Akka Persistence

An Akka Persistence snapshot store backed by Amazon S3. This is a forked version of an abandoned plugin by TanUkkii007 with some new features.

Please note that this module only provides Snapshot plugin.

Configuration

akka.persistence.snapshot-store.plugin = "s3-snapshot-store"

s3-client{
  aws-access-key-id = <your key>
  aws-secret-access-key = <your secret>
  region = "us-west-2"
  endpoint = "default"
  options {
    path-style-access = false
    chunked-encoding-disabled = false
  }
}

s3-snapshot-store {
  bucket-name = "snapshot"
  prefix = "some/dir/" 
  extension = "ss"
  max-load-attempts = 3
}

S3 key structure

A snapshot object is saved with following key format.

<persistenceId>/<reverse sequenceNr>-<timestamp>.<extension>

Note that sequenceNr is reversed to optimize performance for partitioning. See http://docs.aws.amazon.com/AmazonS3/latest/dev/request-rate-perf-considerations.html

S3 namespace structure

The default behaviour is for a snapshot object is saved to the following s3 name space:

<bucketName>/<prefix>/<actor-persistenceId>/

This can however be customised by specifying another implementation of: 'io.findify.akka.persistence.s3.snapshot.keys.SnapshotKeySupport' in the config file using the key:

s3-snapshot-store.key-generator-class = "io.findify.akka.persistence.s3.snapshot.keys.PipePathKeySupport"