s3_set: Configure s3r environment which stores S3 bucket metadata.

View source: R/core.R

s3_setR Documentation

Configure s3r environment which stores S3 bucket metadata.

Description

This environment is required for all s3r functions. Sets bucket name, defines and creates a local cache directory, tracks working directory. There are no default function arguments on purpose, to enable you to call update individual settings without explicitly changing previous settings.

Usage

s3_set(bucket = NULL, profile = NULL, cache = NULL, sse = NULL,
  cwd = NULL, aws.args = NULL, create_command_log = TRUE)

Arguments

bucket

base name for s3 bucket e.g. "s3://bucket-name" or "bucket-name"

profile

character string for the credential profile you configured in aws cli

cache

character string for where to store local versions of downloaded s3 objects. Defaults to current working directory.

sse

logical should server-side encryption be used. NOTE: This does not enable encryption on your bucket, but adds the –sse flag to write commands where it is required for encrypted buckets.

cwd

character string path to define a working prefix. Defults to root of the bucket

aws.args

character string of any additional values you need appended to an aws.cli command line call. This should likely be left blank and applied to individual calls where appropriate.

create_command_log

boolean, if True a file (command.log) will be created in the working directory and appended with all aws command line calls.

Value

list, invisibly returns a list of environment variable settings


dkrozelle/s3r documentation built on May 16, 2022, 8:36 p.m.