To use an Amazon S3 Storage board, you need an Amazon S3 bucket and a user with enough permissions to access the S3 bucket. You can sign-up and create those at https://aws.amazon.com/. Note that it can take a few minutes after you've created it before a bucket is usable.

board_register_s3(
  name = "s3",
  bucket = Sys.getenv("AWS_BUCKET"),
  key = Sys.getenv("AWS_ACCESS_KEY_ID"),
  secret = Sys.getenv("AWS_SECRET_ACCESS_KEY"),
  cache = board_cache_path(),
  host = "s3.amazonaws.com",
  region = NULL,
  path = NULL,
  ...
)

board_s3(
  name = "s3",
  bucket = Sys.getenv("AWS_BUCKET"),
  key = Sys.getenv("AWS_ACCESS_KEY_ID"),
  secret = Sys.getenv("AWS_SECRET_ACCESS_KEY"),
  cache = NULL,
  host = "s3.amazonaws.com",
  ...
)

Arguments

name

Board name, used to identify board in actions that affect multiple boards.

bucket

The name of the Amazon S3 bucket.

key, secret

The key and secret for your space. You can create a key and secret in the "Spaces access keys" in your API settings.

The secret is equivalent to a password, so generally should not be stored in your script. The easiest alternative is to store it in the AWS_SECRET_ACCESS_KEY environment variable, which board_s3() will use by default.

cache

The local folder to use as a cache, defaults to board_cache_path().

host

The host to use for storage, defaults to "s3.amazonaws.com".

region

The region to use, required in some AWS regions and to enable V4 signatures.

path

Subdirectory within url

...

Additional parameters stored in the board object.

See also

Examples

if (FALSE) { # the following example requires an Amazon S3 API key board_register_s3(bucket = "s3bucket") }