awss3: Connection object to a AWS S3 bucket

In INWTlab/rsync: API to use rsync

Connection object to a AWS S3 bucket

Description

Only methods specific to this class are documented here. For others the default method will work. This connection provides the same interface as rsync.

Usage

awss3(dest, src = getwd(), profile = NULL)

profileCreate(profile, force = FALSE)

## S3 method for class 'awss3'
getFile(db, fileName, validate = FALSE, verbose = FALSE, ...)

## S3 method for class 'awss3'
listFiles(db, recursive = FALSE, ...)

## S3 method for class 'awss3'
removeFile(db, fileName, verbose = FALSE, ...)

## S3 method for class 'awss3'
sendAllFiles(db, verbose = FALSE, ...)

## S3 method for class 'awss3'
sendFile(db, fileName, validate = FALSE, verbose = FALSE, args = "", ...)

## S3 method for class 'awss3'
syncAllFiles(db, verbose = FALSE, ...)

Arguments

dest, src	(character) an s3 bucket, e.g. s3://my-bucket or a local directory
profile	(NULL|character|list) the name of a profile or a list defining a profile. In case of a list a new profile will be created which is persistent. A profile is created using aws configure and stores credentials for the user in plain text.
force	(logical) override profile if it exists.
db	(awss3) connection created with awss3
fileName	(character) a file name in dest/src
validate	(logical) if validation should take place
verbose	(logical) if TRUE print more information to the console
...	arguments passed to method
recursive	(logical) if TRUE print full names for files in sub folders
args	(character) pass additional args to aws cli. Currently only implemented for sendFile

Examples

## Not run: 
awss3("s3://my-bucket", profile = list(
  name = "my-profile", # the name of the profile to generate
  aws_access_key_id = "my-access-key-id",
  aws_secret_access_key = "my-secret-access-key",
  region = "my-region"
))
awss3("s3://my-bucket", profile = "my-profile")

## End(Not run)

INWTlab/rsync documentation built on Oct. 25, 2024, 3:50 a.m.