RemotePersistentTerm.Fetcher.S3 (RemotePersistentTerm v0.7.1)

View Source

A Fetcher implementation for AWS S3.

Summary

Types

t()

Functions

init(opts)

Initialize an S3 Fetcher.

Types

t()

@type t() :: %RemotePersistentTerm.Fetcher.S3{
  bucket: String.t(),
  key: String.t(),
  region: String.t() | nil
}

Functions

init(opts)

Initialize an S3 Fetcher.

Requires AWS credentials to be provided via env vars. The following vars must be set to the appropriate values:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_DEFAULT_REGION

Options:

  • :bucket (String.t/0) - Required. The s3 bucket in which the remote term is stored.

  • :key (String.t/0) - Required. The key within the s3 bucket which refers to the remote term.

  • :region (String.t/0) - The AWS region of the s3 bucket.