# `SferaDoc.Pdf.ObjectStore.S3`
[🔗](https://github.com/sfera-lab/sfera-doc/blob/v0.1.0/lib/sfera_doc/pdf/object_store/s3.ex#L1)

Amazon S3 (or S3-compatible) PDF object storage.

Requires the optional dependencies `:ex_aws`, `:ex_aws_s3`, and `:sweet_xml`.

## Configuration

    config :sfera_doc, :pdf_object_store,
      adapter: SferaDoc.Pdf.ObjectStore.S3,
      bucket: "my-pdfs",
      prefix: "sfera_doc/",   # optional, default ""
      ex_aws: []              # optional ExAws.request/2 opts (e.g. region)

ExAws credentials and region are read from the standard ExAws configuration
(`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`, etc.).

## Object key format

    {prefix}{name}/{version}/{assigns_hash}.pdf

---

*Consult [api-reference.md](api-reference.md) for complete listing*