Package 'sixtyfour'

Description

This function simply constructs a string. It only makes an HTTP request if local=TRUE and environment variable AWS_PROFILE != "localstack"

Usage

as_policy_arn(name, local = FALSE, path = NULL)

Arguments

Value

a policy ARN (character)

See Also

Other policies: aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

as_policy_arn("ReadOnlyAccess")
as_policy_arn("arn:aws:iam::aws:policy/ReadOnlyAccess")
as_policy_arn("AmazonRDSDataFullAccess")

# path = Job function
as_policy_arn("Billing", path = "job-function")

# path = Service role
as_policy_arn("AWSCostAndUsageReportAutomationPolicy",
  path = "service-role"
)


as_policy_arn("MyTestPolicy", local = TRUE)
# returns an arn - and if given an arn returns self
as_policy_arn("MyTestPolicy", local = TRUE) %>%
  as_policy_arn()

Description

Fetch billing data - with some internal munging for ease of use

Usage

aws_billing(date_start, date_end = as.character(Sys.Date()), filter = NULL)

Arguments

Value

tibble with columns:

• id: "blended", "unblended"

• date: date, in format yyyy-MM-dd

• service: AWS service name, spelled out in full

• linked_account: account number

• cost: cost in USD

• acronym: short code for the service; if none known, this row will have the value in service

Blended vs. Unblended

• Unblended: Unblended costs represent your usage costs on the day they are charged to you

• Blended: Blended costs are calculated by multiplying each account’s service usage against something called a blended rate. A blended rate is the average rate of on-demand usage, as well as Savings Plans- and reservation-related usage, that is consumed by member accounts in an organization for a particular service.

Historical data

If you supply a date_start older than 14 months prior to today's date you will likely see an error like "You haven't enabled historical data beyond 14 months". See https://docs.aws.amazon.com/cost-management/latest/userguide/ce-advanced-cost-analysis.html #nolint for help

Filtering

You can optionally pass a list to the filter argument to filter AWS costs by different dimensions, tags, or cost categories. This filter expression is passed on to paws. See possible dimensions: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) #nolint

This is supplied as a list, with key-value pairs for each criteria. Different filter criteria can be combined in different ways using AND, OR, and NOT. See Examples below and more on Filter expressions at https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html. #nolint

References

https://www.paws-r-sdk.com/docs/costexplorer/

See Also

Other billing: aws_billing_raw()

Examples

library(lubridate)
library(dplyr)

start_date <- today() - months(13)
z <- aws_billing(date_start = start_date)
z %>%
  filter(id == "blended") %>%
  group_by(service) %>%
  summarise(sum_cost = sum(cost)) %>%
  filter(sum_cost > 0) %>%
  arrange(desc(sum_cost))

z %>%
  filter(id == "blended") %>%
  filter(cost > 0) %>%
  arrange(service)

z %>%
  filter(id == "blended") %>%
  group_by(service) %>%
  summarise(sum_cost = sum(cost)) %>%
  filter(service == "Amazon Relational Database Service")

# Simple filter to return only "Usage" costs:
aws_billing(
  date_start = start_date,
  filter = list(
    Dimensions = list(
      Key = "RECORD_TYPE",
      Values = "Usage"
    )
  )
)

# Filter to return "Usage" costs for only m4.xlarge instances:
aws_billing(
  date_start = start_date,
  filter = list(
    And = list(
      list(
        Dimensions = list(
          Key = "RECORD_TYPE",
          Values = list("Usage")
        )
      ),
      list(
        Dimensions = list(
          Key = "INSTANCE_TYPE",
          Values = list("m4.xlarge")
        )
      )
    )
  )
)

# Complex filter example, translated from the AWS Cost Explorer docs:
# <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html> #nolint
# Filter for operations within us-west-1 or us-west-2 regions OR have a
# specific Tag value, AND are NOT DataTransfer usage types:
aws_billing(
  date_start = start_date,
  filter = list(
    And = list(
      list(
        Or = list(
          list(
            Dimensions = list(
              Key = "REGION",
              Values = list("us-east-1", "us-west-1")
            )
          ),
          list(
            Tags = list(
              Key = "TagName",
              Values = list("Value1")
            )
          )
        )
      ),
      list(
        Not = list(
          Dimensions = list(
            Key = "USAGE_TYPE",
            Values = list("DataTransfer")
          )
        )
      )
    )
  )
)

Description

Fetch billing data - rawest form

Usage

aws_billing_raw(
  date_start,
  metrics,
  granularity = "daily",
  filter = NULL,
  group_by = NULL,
  date_end = as.character(Sys.Date())
)

Arguments

Value

list with slots for:

• NextPageToken

• GroupDefinitions

• ResultsByTime

• DimensionValueAttributes

See Also

Other billing: aws_billing()

Examples

library(lubridate)
aws_billing_raw(date_start = today() - days(3), metrics = "BlendedCost")

Description

Create an S3 bucket

Usage

aws_bucket_create(bucket, ...)

Arguments

Value

the bucket path (character)

Note

Requires the env var AWS_REGION

See Also

Other buckets: aws_bucket_delete(), aws_bucket_download(), aws_bucket_exists(), aws_bucket_list_objects(), aws_bucket_tree(), aws_bucket_upload(), aws_buckets(), six_bucket_delete(), six_bucket_upload()

Examples

bucket2 <- random_bucket()
aws_bucket_create(bucket2)

# cleanup
six_bucket_delete(bucket2, force = TRUE)

Description

Delete an S3 bucket

Usage

aws_bucket_delete(bucket, force = FALSE, ...)

Arguments

Value

NULL, invisibly

Note

Requires the env var AWS_REGION. This function prompts you to make sure that you want to delete the bucket.

See Also

Other buckets: aws_bucket_create(), aws_bucket_download(), aws_bucket_exists(), aws_bucket_list_objects(), aws_bucket_tree(), aws_bucket_upload(), aws_buckets(), six_bucket_delete(), six_bucket_upload()

Examples

bucket_name <- random_bucket()
if (!aws_bucket_exists(bucket_name)) {
  aws_bucket_create(bucket = bucket_name)
  aws_buckets()
  aws_bucket_delete(bucket = bucket_name, force = TRUE)
  aws_buckets()
}

Description

Download an S3 bucket

Usage

aws_bucket_download(bucket, dest_path, ...)

Arguments

Value

path (character) to downloaded file(s)/directory

Note

Requires the env var AWS_REGION. This function prompts you to make sure that you want to delete the bucket.

See Also

Other buckets: aws_bucket_create(), aws_bucket_delete(), aws_bucket_exists(), aws_bucket_list_objects(), aws_bucket_tree(), aws_bucket_upload(), aws_buckets(), six_bucket_delete(), six_bucket_upload()

Examples

bucket <- random_bucket()
aws_bucket_create(bucket = bucket)
desc_file <- file.path(system.file(), "DESCRIPTION")
aws_file_upload(desc_file, s3_path(bucket, "DESCRIPTION.txt"))
aws_file_upload(desc_file, s3_path(bucket, "d_file.txt"))
temp_dir <- file.path(tempdir(), bucket)
aws_bucket_download(bucket = bucket, dest_path = temp_dir)
fs::dir_ls(temp_dir)

# cleanup
six_bucket_delete(bucket, force = TRUE)

Description

Check if an S3 bucket exists

Usage

aws_bucket_exists(bucket)

Arguments

Value

a single boolean (logical)

Note

internally uses head_bucket

See Also

Other buckets: aws_bucket_create(), aws_bucket_delete(), aws_bucket_download(), aws_bucket_list_objects(), aws_bucket_tree(), aws_bucket_upload(), aws_buckets(), six_bucket_delete(), six_bucket_upload()

Examples

bucket1 <- random_bucket()
aws_bucket_create(bucket1)

# exists
aws_bucket_exists(bucket = bucket1)
# does not exist
aws_bucket_exists(bucket = "no-bucket")

# cleanup
six_bucket_delete(bucket1, force = TRUE)

Description

List objects in an S3 bucket

Usage

aws_bucket_list_objects(bucket, ...)

Arguments

Value

if no objects found, an empty tibble. if tibble has rows each is an S3 bucket, with 8 columns:

• bucket_name (character)

• key (character)

• uri (character)

• size (fs::bytes)

• type (character)

• owner (character)

• etag (character)

• last_modified (dttm)

See Also

Other buckets: aws_bucket_create(), aws_bucket_delete(), aws_bucket_download(), aws_bucket_exists(), aws_bucket_tree(), aws_bucket_upload(), aws_buckets(), six_bucket_delete(), six_bucket_upload()

Examples

bucket_name <- random_bucket()
if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name)
links_file <- file.path(system.file(), "Meta/links.rds")
aws_file_upload(
  links_file,
  s3_path(bucket_name, basename(links_file))
)
aws_bucket_list_objects(bucket = bucket_name)
# cleanup
six_bucket_delete(bucket_name, force = TRUE)

Description

Print a tree of the objects in a bucket

Usage

aws_bucket_tree(bucket, recurse = TRUE, ...)

Arguments

Value

character vector of objects/files within the bucket, printed as a tree

See Also

Other buckets: aws_bucket_create(), aws_bucket_delete(), aws_bucket_download(), aws_bucket_exists(), aws_bucket_list_objects(), aws_bucket_upload(), aws_buckets(), six_bucket_delete(), six_bucket_upload()

Examples

bucket_name <- random_bucket()
if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name)
links_file <- file.path(system.file(), "Meta/links.rds")
pkgs_file <- file.path(system.file(), "Meta/package.rds")
demo_file <- file.path(system.file(), "Meta/demo.rds")
aws_file_upload(
  c(links_file, pkgs_file, demo_file),
  s3_path(
    bucket_name,
    c(
      basename(links_file),
      basename(pkgs_file),
      basename(demo_file)
    )
  )
)
aws_bucket_tree(bucket_name)

# cleanup
objs <- aws_bucket_list_objects(bucket_name)
aws_file_delete(objs$uri)
aws_bucket_delete(bucket_name, force = TRUE)
aws_bucket_exists(bucket_name)

Description

Upload a folder of files to create an S3 bucket

Usage

aws_bucket_upload(
  path,
  bucket,
  max_batch = fs::fs_bytes("100MB"),
  force = FALSE,
  ...
)

Arguments

Details

To upload individual files see aws_file_upload()

Value

the s3 format path of the bucket uploaded to

Note

Requires the env var AWS_REGION. This function prompts you to make sure that you want to delete the bucket.

See Also

Other buckets: aws_bucket_create(), aws_bucket_delete(), aws_bucket_download(), aws_bucket_exists(), aws_bucket_list_objects(), aws_bucket_tree(), aws_buckets(), six_bucket_delete(), six_bucket_upload()

Examples

library(fs)
tdir <- path(tempdir(), "apples")
dir.create(tdir)
tfiles <- replicate(n = 10, file_temp(tmp_dir = tdir, ext = ".txt"))
invisible(lapply(tfiles, function(x) write.csv(mtcars, x)))

bucket_name <- random_bucket()
if (!aws_bucket_exists(bucket_name)) aws_bucket_create(bucket_name)
aws_bucket_upload(path = tdir, bucket = bucket_name)
aws_bucket_list_objects(bucket_name)

# cleanup
objs <- aws_bucket_list_objects(bucket_name)
aws_file_delete(objs$uri)
aws_bucket_list_objects(bucket_name)
aws_bucket_delete(bucket_name, force = TRUE)
aws_bucket_exists(bucket_name)

Description

List S3 buckets

Usage

aws_buckets(...)

Arguments

Details

internally uses s3fs::s3_dir_info()

Value

if no objects found, an empty tibble. if tibble has rows each is an S3 bucket, with 8 columns:

• bucket_name (character)

• key (character)

• uri (character)

• size (fs::bytes)

• type (character)

• owner (character)

• etag (character)

• last_modified (dttm)

Note

we set refresh=TRUE internally to make sure we return up to date information about your buckets rather than what's cached locally

See Also

Other buckets: aws_bucket_create(), aws_bucket_delete(), aws_bucket_download(), aws_bucket_exists(), aws_bucket_list_objects(), aws_bucket_tree(), aws_bucket_upload(), six_bucket_delete(), six_bucket_upload()

Examples

aws_buckets()

Description

Configure sixtyfour settings

Usage

aws_configure(redacted = FALSE, redact_str = "*****", verbose = TRUE)

Arguments

Value

S3 class aws_settings

What is Redacted

What's redacted is currently hard-coded in the package. There's only certain functions and certain elements in the output of those functions that are redacted. The following is what's redacted with aws_configure(redacted = TRUE) or with_redacted():

• aws_whoami(): AWS Account ID via account_id()

• six_user_creds(): Access Key ID

• groups functions:

  • functions: aws_groups(), aws_group(), aws_group_create()

  • attribute: Arn (includes AWS Account ID)

• roles functions:

  • functions: aws_roles(), aws_role(), aws_role_create()

  • attribute: Arn (includes AWS Account ID)

• user functions:

  • functions: aws_users(), aws_user(), aws_user_create(), aws_user_add_to_group(), aws_user_remove_from_group()

  • attribute: Arn (includes AWS Account ID)

• aws_user_access_key_delete(): Access Key ID

Description

Get cluster status

Usage

aws_db_cluster_status(id)

Arguments

Value

(character) the status of the cluster, e.g., "creating", "available", "not found"

See Also

Other database: aws_db_instance_status(), aws_db_rds_con(), aws_db_rds_create(), aws_db_rds_list(), aws_db_redshift_con(), aws_db_redshift_create()

Examples

## Not run: 
aws_db_cluster_status(id = "scotts-test-cluster-456")

## End(Not run)

Description

Get instance status

Usage

aws_db_instance_status(id)

Arguments

Value

(character) the status of the instance, e.g., "creating", "available", "not found"

See Also

Other database: aws_db_cluster_status(), aws_db_rds_con(), aws_db_rds_create(), aws_db_rds_list(), aws_db_redshift_con(), aws_db_redshift_create()

Examples

## Not run: 
aws_db_instance_status(id = "thedbinstance")

## End(Not run)

Description

Supports: MariaDB, MySQL, and Postgres

Usage

aws_db_rds_con(
  user = NULL,
  pwd = NULL,
  id = NULL,
  host = NULL,
  port = NULL,
  dbname = NULL,
  engine = NULL,
  ...
)

Arguments

Details

RDS supports many databases, but we only provide support for MariaDB, MySQL, and Postgres

If the engine you've chosen for your RDS instance is not supported with this function, you can likely connect to it on your own

Value

an S4 object that inherits from DBIConnection

See Also

Other database: aws_db_cluster_status(), aws_db_instance_status(), aws_db_rds_create(), aws_db_rds_list(), aws_db_redshift_con(), aws_db_redshift_create()

Examples

## Not run: 
con_rds <- aws_db_rds_con("<define all params here>")
con_rds

library(DBI)
library(RMariaDB)
dbListTables(con_rds)
dbWriteTable(con_rds, "mtcars", mtcars)
dbListTables(con_rds)
dbReadTable(con_rds, "mtcars")

library(dplyr)
tbl(con_rds, "mtcars")

## End(Not run)

Description

Create an RDS cluster

Usage

aws_db_rds_create(
  id,
  class,
  user = NULL,
  pwd = NULL,
  dbname = "dev",
  engine = "mariadb",
  storage = 20,
  storage_encrypted = TRUE,
  security_group_ids = NULL,
  wait = TRUE,
  verbose = TRUE,
  aws_secrets = TRUE,
  iam_database_auth = FALSE,
  ...
)

Arguments

Details

See above link to create_db_instance docs for details on requirements for each parameter

Note that even though you can use any option for engine in this function, we may not provide the ability to connect to the chosen data source in this package.

Value

returns NULL, this function called for the side effect of creating an RDS instance

Waiting

Note that with wait = TRUE this function waits for the instance to be available for returning. That wait can be around 5 - 7 minutes. You can instead set wait = FALSE and then check on the status of the instance yourself in the AWS dashboard.

See Also

Other database: aws_db_cluster_status(), aws_db_instance_status(), aws_db_rds_con(), aws_db_rds_list(), aws_db_redshift_con(), aws_db_redshift_create()

Description

Get information for all RDS instances

Usage

aws_db_rds_list()

Value

a tibble of instance details; see https://www.paws-r-sdk.com/docs/rds_describe_db_instances/ an empty tibble if no instances found

See Also

Other database: aws_db_cluster_status(), aws_db_instance_status(), aws_db_rds_con(), aws_db_rds_create(), aws_db_redshift_con(), aws_db_redshift_create()

Examples

aws_db_rds_list()

Description

Get a database connection to Amazon Redshift

Usage

aws_db_redshift_con(
  user,
  pwd,
  id = NULL,
  host = NULL,
  port = NULL,
  dbname = NULL,
  ...
)

Arguments

Details

The connection returned is created using RPostgres

You can manage Redshift programatically via paws::redshift

Value

an object of class RedshiftConnection

See Also

Other database: aws_db_cluster_status(), aws_db_instance_status(), aws_db_rds_con(), aws_db_rds_create(), aws_db_rds_list(), aws_db_redshift_create()

Examples

## Not run: 
library(DBI)
library(RPostgres)

con_rshift <- aws_db_redshift_con("<define all params here>")
con_rshift
library(RPostgres)
dbListTables(con_rshift)
dbWriteTable(con_rshift, "mtcars", mtcars)
dbListTables(con_rshift)

library(dplyr)
tbl(con_rshift, "mtcars")

## End(Not run)

Description

Create a Redshift cluster

Usage

aws_db_redshift_create(
  id,
  user,
  pwd,
  dbname = "dev",
  cluster_type = "multi-node",
  node_type = "dc2.large",
  number_nodes = 2,
  security_group_ids = NULL,
  wait = TRUE,
  verbose = TRUE,
  ...
)

Arguments

Value

returns NULL, this function called for the side effect of creating an Redshift instance

Waiting

Note that with wait = TRUE this function waits for the instance to be available for returning. That wait can be around 5 - 7 minutes. You can instead set wait = FALSE and then check on the status of the instance yourself in the AWS dashboard.

Note

See above link to create_cluster docs for details on requirements for each parameter

See Also

Other database: aws_db_cluster_status(), aws_db_instance_status(), aws_db_rds_con(), aws_db_rds_create(), aws_db_rds_list(), aws_db_redshift_con()

Description

File attributes

Usage

aws_file_attr(remote_path)

Arguments

Value

a tibble with many columns, with number of rows matching length of remote_path

Note

uses s3fs::s3_file_info() internally

See Also

Other files: aws_file_copy(), aws_file_delete(), aws_file_download(), aws_file_exists(), aws_file_rename(), aws_file_upload(), six_file_upload()

Examples

library(glue)
bucket <- random_bucket()
if (!aws_bucket_exists(bucket)) {
  aws_bucket_create(bucket)
}

# upload some files
tfiles <- replicate(n = 3, tempfile())
paths <- s3_path(bucket, glue("{basename(tfiles)}.txt"))
for (file in tfiles) cat("Hello saturn!!!!!!\n", file = file)
for (file in tfiles) print(readLines(file))
aws_file_upload(path = tfiles, remote_path = paths)

# files one by one
aws_file_attr(paths[1])
aws_file_attr(paths[2])
aws_file_attr(paths[3])
# or all together
aws_file_attr(paths)

# Cleanup
six_bucket_delete(bucket, force = TRUE)

Description

Copy files between buckets

Usage

aws_file_copy(remote_path, bucket, force = FALSE, ...)

Arguments

Value

vector of paths, length matches length(remote_path)

See Also

Other files: aws_file_attr(), aws_file_delete(), aws_file_download(), aws_file_exists(), aws_file_rename(), aws_file_upload(), six_file_upload()

Examples

bucket1 <- random_bucket()
aws_bucket_create(bucket1)

# create files in an existing bucket
tfiles <- replicate(n = 3, tempfile())
for (i in tfiles) cat("Hello\nWorld\n", file = i)
paths <- s3_path(bucket1, c("aaa", "bbb", "ccc"), ext = "txt")
aws_file_upload(tfiles, paths)

# create a new bucket
bucket2 <- random_bucket()
new_bucket <- aws_bucket_create(bucket = bucket2)

# add existing files to the new bucket
aws_file_copy(paths, bucket2)

# or, create a bucket that doesn't exist yet
bucket3 <- random_bucket()
aws_file_copy(paths, bucket3, force = TRUE)

# Cleanup
six_bucket_delete(bucket1, force = TRUE)
six_bucket_delete(bucket2, force = TRUE)
six_bucket_delete(bucket3, force = TRUE)

Description

Delete a file

Usage

aws_file_delete(remote_path, ...)

Arguments

Value

NULL invisibly

See Also

Other files: aws_file_attr(), aws_file_copy(), aws_file_download(), aws_file_exists(), aws_file_rename(), aws_file_upload(), six_file_upload()

Examples

# create a file
bucket <- random_bucket()
aws_bucket_create(bucket)
tfile <- tempfile()
cat("Hello World!\n", file = tfile)
aws_file_upload(path = tfile, remote_path = s3_path(bucket))

# delete the file
aws_file_delete(s3_path(bucket, basename(tfile)))

# file does not exist - no error is raised
aws_file_delete(s3_path(bucket, "TESTING123"))

# Cleanup
six_bucket_delete(bucket, force = TRUE)

Description

Download a file

Usage

aws_file_download(remote_path, path, ...)

Arguments

Value

(character) a vector of local file paths

See Also

Other files: aws_file_attr(), aws_file_copy(), aws_file_delete(), aws_file_exists(), aws_file_rename(), aws_file_upload(), six_file_upload()

Examples

library(glue)

# single file
bucket1 <- random_bucket()
aws_bucket_create(bucket1)
tfile1 <- tempfile()
remote1 <- s3_path(bucket1, glue("{basename(tfile1)}.txt"))
cat("Hello World!\n", file = tfile1)
aws_file_upload(path = tfile1, remote_path = remote1)
dfile <- tempfile()
aws_file_download(remote_path = remote1, path = dfile)
readLines(dfile)

# many files
bucket2 <- random_bucket()
aws_bucket_create(bucket2)
tfiles <- replicate(n = 3, tempfile())
for (file in tfiles) cat("Hello mars!!!!!!\n", file = file)
for (file in tfiles) print(readLines(file))
for (file in tfiles) {
  aws_file_upload(file, s3_path(bucket2, glue("{basename(file)}.txt")))
}
downloadedfiles <- replicate(n = 3, tempfile())
for (file in downloadedfiles) print(file.exists(file))
remotes2 <- s3_path(bucket2, glue("{basename(tfiles)}.txt"))
aws_file_download(remote_path = remotes2, path = downloadedfiles)
for (file in downloadedfiles) print(readLines(file))

# Cleanup
six_bucket_delete(bucket1, force = TRUE)
six_bucket_delete(bucket2, force = TRUE)

Description

Check if a file exists

Usage

aws_file_exists(remote_path)

Arguments

Value

vector of booleans (TRUE or FALSE), length matches length(remote_path)

See Also

Other files: aws_file_attr(), aws_file_copy(), aws_file_delete(), aws_file_download(), aws_file_rename(), aws_file_upload(), six_file_upload()

Examples

library(glue)
bucket <- random_bucket()
aws_bucket_create(bucket)

# upload some files
tfiles <- replicate(n = 3, tempfile())
paths <- s3_path(bucket, glue("{basename(tfiles)}.txt"))
for (file in tfiles) cat("Hello saturn!!!!!!\n", file = file)
for (file in tfiles) print(readLines(file))
aws_file_upload(path = tfiles, remote_path = paths)

# check that files exist
aws_file_exists(paths[1])
aws_file_exists(paths[2])
aws_file_exists(s3_path(bucket, "doesnotexist.txt"))

# Cleanup
six_bucket_delete(bucket, force = TRUE)

Description

Rename remote files

Usage

aws_file_rename(remote_path, new_remote_path, ...)

Arguments

Value

vector of paths, length matches length(remote_path)

See Also

Other files: aws_file_attr(), aws_file_copy(), aws_file_delete(), aws_file_download(), aws_file_exists(), aws_file_upload(), six_file_upload()

Examples

bucket <- random_bucket()
aws_bucket_create(bucket)

# rename files
tfiles <- replicate(n = 3, tempfile())
for (i in tfiles) cat("Hello\nWorld\n", file = i)
paths <- s3_path(bucket, c("aaa", "bbb", "ccc"), ext = "txt")
aws_file_upload(tfiles, paths)
new_paths <- s3_path(bucket, c("new_aaa", "new_bbb", "new_ccc"),
  ext = "txt"
)
aws_file_rename(paths, new_paths)

# Cleanup
six_bucket_delete(bucket, force = TRUE)

Description

Upload a file

Usage

aws_file_upload(path, remote_path, ...)

Arguments

Details

to upload a folder of files see aws_bucket_upload()

Value

(character) a vector of remote s3 paths

See Also

Other files: aws_file_attr(), aws_file_copy(), aws_file_delete(), aws_file_download(), aws_file_exists(), aws_file_rename(), six_file_upload()

Examples

bucket1 <- random_bucket()
aws_bucket_create(bucket1)
cat(bucket1)
demo_rds_file <- file.path(system.file(), "Meta/demo.rds")
aws_file_upload(
  demo_rds_file,
  s3_path(bucket1, basename(demo_rds_file))
)

## many files at once
bucket2 <- random_bucket()
if (!aws_bucket_exists(bucket2)) {
  aws_bucket_create(bucket2)
}
cat(bucket2)
links_file <- file.path(system.file(), "Meta/links.rds")
aws_file_upload(
  c(demo_rds_file, links_file),
  s3_path(bucket2, c(basename(demo_rds_file), basename(links_file))),
  overwrite = TRUE
)

# set expiration, expire 1 minute from now
aws_file_upload(demo_rds_file, s3_path(bucket2, "ddd.rds"),
  Expires = Sys.time() + 60,
  overwrite = TRUE
)

# bucket doesn't exist
try(aws_file_upload(demo_rds_file, "s3://not-a-bucket/eee.rds"))

# path doesn't exist
try(
  aws_file_upload(
    "file_doesnt_exist.txt",
    s3_path(bucket2, "file_doesnt_exist.txt")
  )
)

# Path's without file extensions behave a little weird
## With extension
bucket3 <- random_bucket()
if (!aws_bucket_exists(bucket3)) {
  aws_bucket_create(bucket3)
}
## Both the next two lines do the same exact thing: make a file in the
## same path in a bucket
pkg_rds_file <- file.path(system.file(), "Meta/package.rds")
aws_file_upload(pkg_rds_file, s3_path(bucket3, "package2.rds"),
 overwrite = TRUE)
aws_file_upload(pkg_rds_file, s3_path(bucket3),
 overwrite = TRUE)

## Without extension
## However, it's different for a file without an extension
## This makes a file in the bucket at path DESCRIPTION
rd_file <- file.path(system.file(), "Meta/Rd.rds")
desc_file <- system.file("DESCRIPTION", package = "sixtyfour")
aws_file_upload(desc_file, s3_path(bucket3), overwrite = TRUE)

## Whereas this creates a directory called DESCRIPTION with
## a file DESCRIPTION within it
aws_file_upload(desc_file, s3_path(bucket3, "DESCRIPTION"),
  overwrite = TRUE)

# Cleanup
six_bucket_delete(bucket1, force = TRUE)
six_bucket_delete(bucket2, force = TRUE)
six_bucket_delete(bucket3, force = TRUE)

Description

Get a group

Usage

aws_group(name)

Arguments

Details

see docs https://www.paws-r-sdk.com/docs/iam_get_group/

Value

a named list with slots for:

• group: information about the group (tibble)

• users: users in the group (tibble)

• policies (character)

• attached_policies (tibble)

See Also

Other groups: aws_group_create(), aws_group_delete(), aws_group_exists(), aws_groups(), six_group_delete()

Examples

# create a group
aws_group_create("testing")
# get the group
aws_group(name = "testing")
# cleanup
aws_group_delete(name = "testing")

Description

Create a group

Usage

aws_group_create(name, path = NULL)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_create_group/ docs for details on the parameters

Value

A tibble with information about the group created

See Also

Other groups: aws_group(), aws_group_delete(), aws_group_exists(), aws_groups(), six_group_delete()

Examples

aws_group_create("testingagroup")
aws_group("testingagroup")
# cleanup
aws_group_delete("testingagroup")

Description

Delete a group

Usage

aws_group_delete(name)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_delete_group/ docs for more details

Value

NULL invisibly

See Also

Other groups: aws_group(), aws_group_create(), aws_group_exists(), aws_groups(), six_group_delete()

Examples

aws_group_create("somegroup")
aws_group_delete("somegroup")

Description

Check if a group exists

Usage

aws_group_exists(name)

Arguments

Details

uses aws_group internally. see docs https://www.paws-r-sdk.com/docs/iam_get_group/

Value

a single boolean

See Also

Other groups: aws_group(), aws_group_create(), aws_group_delete(), aws_groups(), six_group_delete()

Examples

aws_group_create("apples")
aws_group_exists("apples")
aws_group_exists("doesnotexist")
# cleanup
aws_group_delete("apples")

Description

List all groups or groups for a single user

Usage

aws_groups(username = NULL, ...)

Arguments

Value

A tibble with information about groups

See Also

Other groups: aws_group(), aws_group_create(), aws_group_delete(), aws_group_exists(), six_group_delete()

Examples

aws_groups()
aws_groups(username = aws_user_current())

Description

Check if appropriate AWS credentials are available

Usage

aws_has_creds()

Value

single boolean

Examples

aws_has_creds()

Description

List policies

Usage

aws_policies(refresh = FALSE, ...)

Arguments

Details

uses memoise internally to cache results to speed up all subsequent calls to the function

Value

A tibble with information about policies. Each row is a policy. Columns:

• PolicyName

• PolicyId

• Path

• Arn

• CreateDate

• UpdateDate

• AttachmentCount

• PermissionsBoundaryUsageCount

• IsAttachable

• Description

• Tags

See Also

Other policies: as_policy_arn(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

# takes a while on the first execution in an R session
aws_policies()


# faster because first call memoised the result
aws_policies()
# refresh=TRUE will pull from AWS
aws_policies(refresh = TRUE)

Description

Get a policy

Usage

aws_policy(name, local = FALSE, path = NULL)

Arguments

Details

see docs https://www.paws-r-sdk.com/docs/iam_get_policy/

Value

a tibble with policy details

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

# get an AWS managed policy (local = FALSE - the default)
aws_policy("AmazonS3FullAccess")

# get a policy by arn
aws_policy("arn:aws:iam::aws:policy/AmazonS3FullAccess")

Description

Attach a policy to a user, group, or role

Usage

aws_policy_attach(.x, policy)

Arguments

Value

A tibble with information about policies

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

if (aws_user_exists("user123")) {
  aws_user_delete("user123")
}

aws_user_create("user123")
aws_policy("AmazonRDSDataFullAccess")
aws_user("user123") %>% aws_policy_attach("AmazonRDSDataFullAccess")
aws_user("user123")$attached_policies
# cleanup
six_user_delete("user123")

Description

Create a policy

Usage

aws_policy_create(name, document, path = NULL, description = NULL, tags = NULL)

Arguments

Details

see docs https://www.paws-r-sdk.com/docs/iam_create_policy/

Value

a tibble with policy details

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

if (aws_policy_exists("MyPolicy123")) {
  aws_policy_delete("MyPolicy123")
}

# Create policy document
st8ment1 <- aws_policy_statement("iam:GetUser", "*")
st8ment2 <- aws_policy_statement("s3:ListAllMyBuckets", "*")
doc <- aws_policy_document_create(st8ment1, st8ment2)

# Create policy
aws_policy_create("MyPolicy123", document = doc)

# cleanup - delete policy
aws_policy_delete("MyPolicy123")

Description

Delete a user managed policy

Usage

aws_policy_delete(name)

Arguments

Value

invisibly returns NULL

AWS managed policies

You can not delete AWS managed policies.

Deleting process (adapted from paws docs)

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:

• Detach the policy from all users, groups, and roles that the policy is attached to using aws_policy_attach(). To list all the users, groups, and roles that a policy is attached to use aws_policy_list_entities()

• Delete all versions of the policy using aws_policy_delete_version(). To list the policy's versions, use aws_policy_list_versions(). You cannot use aws_policy_delete_version() to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

• Delete the policy using this function (this automatically deletes the policy's default version)

References

delete_policy

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

if (aws_policy_exists("RdsAllow456")) {
  aws_policy_delete("RdsAllow456")
}

# Create policy document
doc <- aws_policy_document_create(
  aws_policy_statement(
    action = "rds-db:connect",
    resource = "*"
  )
)

# Create policy
invisible(aws_policy_create("RdsAllow456", document = doc))

# Delete policy
aws_policy_delete("RdsAllow456")

Description

Delete a policy version

Usage

aws_policy_delete_version(name, version_id)

Arguments

Value

invisibly returns NULL

References

https://www.paws-r-sdk.com/docs/iam_delete_policy_version/

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

if (aws_policy_exists("RdsAllow888")) {
  aws_policy_delete("RdsAllow888")
}

# Create policy document
doc <- aws_policy_document_create(
  aws_policy_statement(
    action = "rds-db:connect",
    resource = "*"
  )
)

# Create policy
invisible(aws_policy_create("RdsAllow888", document = doc))

# Add a new version of the policy
st8ment1 <- aws_policy_statement("iam:GetUser", "*")
new_doc <- aws_policy_document_create(st8ment1)
arn <- as_policy_arn("RdsAllow888", local = TRUE)
aws_policy_update(arn, document = new_doc, defaul = TRUE)

# List versions of the policy
aws_policy_list_versions("RdsAllow888")

# Delete a policy version
aws_policy_delete_version("RdsAllow888", "v1")

# Cleanup - delete  policy
aws_policy_delete("RdsAllow888")

Description

Detach a policy from a user, group, or role

Usage

aws_policy_detach(.x, policy)

Arguments

Value

A tibble with information about policies

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

if (aws_user_exists("user456")) {
  aws_user_delete("user456")
}

aws_user_create("user456")
aws_user("user456") %>% aws_policy_attach("AmazonRDSDataFullAccess")
aws_user("user456") %>% aws_policy_detach("AmazonRDSDataFullAccess")
aws_user("user456")$attached_policies
# cleanup
six_user_delete("user456")

Description

Create a policy document

Usage

aws_policy_document_create(..., .list = NULL)

Arguments

Value

a json class string. use as.character() to coerce to a regular string

Actions

Actions documentation appears to be all over the web. Here's a start:

• S3: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html # nolint

• EC2: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html # nolint

• IAM: https://docs.aws.amazon.com/IAM/latest/APIReference/API_Operations.html # nolint

Note

a document item is hard-coded:

• Version is set to 2012-10-17"

References

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html # nolint

Examples

library(jsonlite)

st8ment1 <- aws_policy_statement("iam:GetUser", "*")
st8ment2 <- aws_policy_statement("s3:ListAllMyBuckets", "*")
st8ment3 <- aws_policy_statement("s3-object-lambda:List*", "*")
aws_policy_document_create(st8ment1, st8ment2) %>% prettify()
aws_policy_document_create(.list = list(st8ment1, st8ment2)) %>% prettify()
aws_policy_document_create(st8ment3, .list = list(st8ment1, st8ment2)) %>%
  prettify()

# Policy document to give a user access to RDS
resource <- "arn:aws:rds-db:us-east-2:1234567890:dbuser:db-ABCDE1212/jane"
st8ment_rds <- aws_policy_statement(
  action = "rds-db:connect",
  resource = resource
)
aws_policy_document_create(st8ment_rds) %>% prettify()


### DB account = user in a database that has access to it
# all DB instances & DB accounts for a AWS account and AWS Region
aws_policy_document_create(
  aws_policy_statement(
    action = "rds-db:connect",
    resource = resource_rds("*", "*")
  )
) %>% prettify()
# all DB instances for a AWS account and AWS Region, single DB account
aws_policy_document_create(
  aws_policy_statement(
    action = "rds-db:connect",
    resource = resource_rds("jane_doe", "*")
  )
) %>% prettify()
# single DB instasnce, single DB account
aws_policy_document_create(
  aws_policy_statement(
    action = "rds-db:connect",
    resource = resource_rds("jane_doe", "db-ABCDEFGHIJKL01234")
  )
) %>% prettify()
# single DB instance, many users
aws_policy_document_create(
  aws_policy_statement(
    action = "rds-db:connect",
    resource = resource_rds(c("jane_doe", "mary_roe"), "db-ABCDEFGHIJKL01")
  )
) %>% prettify()

Description

Checks for both customer managed and AWS managed policies

Usage

aws_policy_exists(name)

Arguments

Value

single logical, TRUE or FALSE

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_list_entities(), aws_policy_list_versions(), aws_policy_update()

Examples

# just the policy name
aws_policy_exists("ReadOnlyAccess")
# as an ARN
aws_policy_exists("arn:aws:iam::aws:policy/ReadOnlyAccess")
# includes job-function in path
aws_policy_exists("Billing")
# includes service-role in path
aws_policy_exists("AWSCostAndUsageReportAutomationPolicy")

Description

List policy entities

Usage

aws_policy_list_entities(name, ...)

Arguments

Value

tibble with columns:

• type: one of Users, Roles, Groups

• name: the user, role or group name

• id: the id for the user, role or group name

Zero row tibble if there are no entities

References

https://www.paws-r-sdk.com/docs/iam_list_entities_for_policy/

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_versions(), aws_policy_update()

Examples

aws_policy_list_entities("AdministratorAccess")
aws_policy_list_entities("AmazonRedshiftReadOnlyAccess")

Description

List policy versions

Usage

aws_policy_list_versions(name, ...)

Arguments

Value

tibble with columns:

• VersionId

• IsDefaultVersion

• CreateDate

References

https://www.paws-r-sdk.com/docs/iam_list_policy_versions/

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_update()

Examples

aws_policy_list_versions("AmazonS3FullAccess")
aws_policy_list_versions("AmazonAppFlowFullAccess")
aws_policy_list_versions("AmazonRedshiftFullAccess")

Description

Create a policy statement

Usage

aws_policy_statement(action, resource, effect = "Allow", ...)

Arguments

Details

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html #nolint

Value

a named list

Examples

aws_policy_statement("iam:GetUser", "*")
aws_policy_statement("iam:GetUser", "*", Sid = "MyStatementId")
aws_policy_statement("iam:GetUser", "*",
  Condition = list(
    StringEqualsIgnoreCase = list("aws:username" = "johndoe")
  )
)
aws_policy_statement("iam:GetUser", "*",
  Principal = list(Service = "s3.amazonaws.com")
)

Description

Update a policy

Usage

aws_policy_update(arn, document, default = FALSE)

Arguments

Details

see docs https://www.paws-r-sdk.com/docs/iam_create_policy_version/

Value

a tibble with policy version details:

• VersionId

• IsDefaultVersion

• CreateDate

See Also

Other policies: as_policy_arn(), aws_policies(), aws_policy(), aws_policy_attach(), aws_policy_create(), aws_policy_delete(), aws_policy_delete_version(), aws_policy_detach(), aws_policy_exists(), aws_policy_list_entities(), aws_policy_list_versions()

Examples

if (aws_policy_exists("polisee")) {
  aws_policy_delete("polisee")
}

# Create policy document
st8ment1 <- aws_policy_statement("iam:GetUser", "*")
st8ment2 <- aws_policy_statement("s3:ListAllMyBuckets", "*")
doc <- aws_policy_document_create(st8ment1, st8ment2)

# Create policy
invisible(aws_policy_create("polisee", document = doc))

# Update the same policy
new_doc <- aws_policy_document_create(st8ment1)
arn <- as_policy_arn("polisee", local = TRUE)
aws_policy_update(arn, document = new_doc, default = TRUE)
aws_policy_list_versions("polisee")

# cleanup - delete the policy
aws_policy_delete_version("polisee", "v1")
aws_policy_delete("polisee")

Description

Get a role

Usage

aws_role(name)

Arguments

Details

see docs https://www.paws-r-sdk.com/docs/iam_get_role/; also includes policies and attached policies by calling list_role_policies and list_attached_role_policies

Value

a named list with slots for:

• role (tibble)

• policies (character)

• attached_policies (tibble)

See Also

Other roles: aws_role_create(), aws_role_delete(), aws_role_exists(), aws_roles()

Examples

trust_policy <- list(
  Version = "2012-10-17",
  Statement = list(
    list(
      Effect = "Allow",
      Principal = list(
        Service = "lambda.amazonaws.com"
      ),
      Action = "sts:AssumeRole"
    )
  )
)
doc <- jsonlite::toJSON(trust_policy, auto_unbox = TRUE)
desc <- "Another test role"
z <- aws_role_create("ALittleRole",
  assume_role_policy_document = doc,
  description = desc
)
aws_policy_attach(z, "ReadOnlyAccess")
res <- aws_role(name = "ALittleRole")
res
res$role
res$policies
res$attached_policies

# cleanup
aws_role("ALittleRole") %>%
  aws_policy_detach("ReadOnlyAccess")
aws_role_delete("ALittleRole")

Description

Create a role

Usage

aws_role_create(
  name,
  assume_role_policy_document,
  path = NULL,
  description = NULL,
  max_session_duration = NULL,
  permission_boundary = NULL,
  tags = NULL
)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_create_role/ docs for details on the parameters

Value

A tibble with information about the role created

See Also

Other roles: aws_role(), aws_role_delete(), aws_role_exists(), aws_roles()

Examples

role_name <- "AMinorRole"
trust_policy <- list(
  Version = "2012-10-17",
  Statement = list(
    list(
      Effect = "Allow",
      Principal = list(
        Service = "lambda.amazonaws.com"
      ),
      Action = "sts:AssumeRole"
    )
  )
)
doc <- jsonlite::toJSON(trust_policy, auto_unbox = TRUE)
desc <- "My test role"
z <- aws_role_create(role_name,
  assume_role_policy_document = doc,
  description = desc
)
# attach a policy
invisible(z %>% aws_policy_attach("AWSLambdaBasicExecutionRole"))

# cleanup
invisible(z %>% aws_policy_detach("AWSLambdaBasicExecutionRole"))
aws_role_delete(role_name)

Description

Delete a role

Usage

aws_role_delete(name)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_delete_role/ docs for more details

Value

NULL invisibly

See Also

Other roles: aws_role(), aws_role_create(), aws_role_exists(), aws_roles()

Examples

if (aws_role_exists(name = "MyRole")) {
  aws_role_delete(name = "MyRole")
}

Description

Check if a role exists

Usage

aws_role_exists(name)

Arguments

Value

a single boolean

See Also

Other roles: aws_role(), aws_role_create(), aws_role_delete(), aws_roles()

Examples

aws_role_exists("AWSServiceRoleForRedshift")
aws_role_exists("NotARole")

Description

List roles

Usage

aws_roles(...)

Arguments

Value

A tibble with information about roles

See Also

Other roles: aws_role(), aws_role_create(), aws_role_delete(), aws_role_exists()

Examples

aws_roles()

Description

Create a policy document for an S3 bucket

Usage

aws_s3_policy_doc_create(
  bucket,
  action,
  resource,
  effect = "Allow",
  sid = NULL,
  ...
)

Arguments

Details

There's this separate function for creating policy docs for S3 because buckets are globally unique, so AWS figures out the region and account ID for you.

Value

a policy document as JSON (of class json)

Examples

bucket <- random_bucket()
aws_s3_policy_doc_create(
  bucket = bucket,
  action = s3_actions_read(),
  resource = c(bucket_arn(bucket), bucket_arn(bucket, objects = "*"))
)

Description

Get all secret values

Usage

aws_secrets_all()

Value

(tbl) with secrets

Examples

aws_secrets_all()

Description

This function does not create your database username and/or password. Instead, it creates a "secret", which is typically a combination of credentials (username + password + other metadata)

Usage

aws_secrets_create(name, secret, description = NULL, ...)

Arguments

Details

Note that we autogenerate a random UUID to pass to the ClientRequestToken parameter of the paws function create_secret used internally in this function.

This function creates a new secret. See aws_secrets_update() to update an existing secret. This function fails if you call it with an existing secret with the same name or ARN

Value

(list) with fields:

• ARN

• Name

• VersionId

• ReplicationStatus

Examples

try({
# Text secret
secret1 <- random_string("secret-", size = 16)
aws_secrets_create(
  name = secret1,
  secret = '{"username":"david","password":"EXAMPLE-PASSWORD"}',
  description = "My test database secret as a string"
)
aws_secrets_get(secret1)$SecretString

# Raw secret
secret2 <- random_string("secret-", size = 16)
aws_secrets_create(
  name = secret2,
  secret = charToRaw('{"username":"david","password":"EXAMPLE-PASSWORD"}'),
  description = "My test database secret as raw"
)
aws_secrets_get(secret2)$SecretBinary

# Cleanup
aws_secrets_delete(secret1, ForceDeleteWithoutRecovery = TRUE)
aws_secrets_delete(secret2, ForceDeleteWithoutRecovery = TRUE)
})

Description

Delete a secret

Usage

aws_secrets_delete(id, ...)

Arguments

Value

(list) with fields:

• ARN

• Name

• DeletionDate

Examples

try({
# Create a secret
secret <- random_string("secret-", size = 16)
aws_secrets_create(
  name = secret,
  secret = '{"username":"jill","password":"cow"}',
  description = "The fox jumped over the cow"
)

# Delete a secret
aws_secrets_delete(id = secret, ForceDeleteWithoutRecovery = TRUE)
})

Description

Get a secret

Usage

aws_secrets_get(id, ...)

Arguments

Value

(list) with fields:

• ARN

• Name

• VersionId

• SecretBinary

• SecretString

• VersionStages

• CreatedDate

Examples

try({
# Create a secret
secret <- random_string("secret-", size = 16)
aws_secrets_create(
  name = secret,
  secret = '{"username":"jane","password":"cat"}',
  description = "A string"
)

aws_secrets_get(secret)

# Does exist
aws_secrets_get(id = "MyTestDatabaseSecret")

# Does not exist
try(aws_secrets_get(id = "DoesntExist"))

# Cleanup
aws_secrets_delete(secret, ForceDeleteWithoutRecovery = TRUE)
})

Description

List secrets

Usage

aws_secrets_list(...)

Arguments

Value

(list) list with secrets

Note

see https://www.paws-r-sdk.com/docs/secretsmanager_list_secrets/ for available parameters

Examples

aws_secrets_list()

Description

Get a random password

Usage

aws_secrets_pwd(...)

Arguments

Details

The parameter PasswordLength is hard coded to 40L

Value

a single string, of length 40

Examples

aws_secrets_pwd()
aws_secrets_pwd(ExcludeNumbers = TRUE)

Description

Rotate a secret

Usage

aws_secrets_rotate(id, lambda_arn = NULL, rules = NULL, immediately = TRUE)

Arguments

Details

Note that we autogenerate a random UUID to pass to the ClientRequestToken parameter of the paws function used internally

Value

(list) with fields:

• ARN

• Name

• VersionId

References

https://www.paws-r-sdk.com/docs/secretsmanager_rotate_secret/

Examples

try({
# Create a secret
secret <- random_string("secret-", size = 16)
aws_secrets_create(
  name = secret,
  secret = '{"username":"billy","password":"willy"}',
  description = "A string"
)

# Rotate
try(aws_secrets_rotate(id = secret))

# Cleanup
aws_secrets_delete(secret, ForceDeleteWithoutRecovery = TRUE)
})

Description

Update a secret

Usage

aws_secrets_update(id, secret, ...)

Arguments

Details

Note that we autogenerate a random UUID to pass to the ClientRequestToken parameter of the paws function used internally

Value

(list) with fields:

• ARN

• Name

• VersionId

• VersionStages

Examples

try({
# Create a secret
secret <- random_string("secret-", size = 16)
aws_secrets_create(
  name = secret,
  secret = '{"username":"debby","password":"kitty"}',
  description = "A string"
)

aws_secrets_get(secret)

# Update the secret
aws_secrets_update(
  id = secret,
  secret = '{"username":"debby","password":"kitten"}'
)

aws_secrets_get(secret)

# Cleanup
aws_secrets_delete(secret, ForceDeleteWithoutRecovery = TRUE)
})

Description

Gets user information, including policies, groups, and attached policies

Usage

aws_user(username = NULL)

Arguments

Details

See the following docs links for details

• https://www.paws-r-sdk.com/docs/iam_get_user/

• https://www.paws-r-sdk.com/docs/iam_list_user_policies/

• https://www.paws-r-sdk.com/docs/iam_list_groups_for_user/

• https://www.paws-r-sdk.com/docs/iam_list_attached_user_policies/

Value

a named list with slots for:

• user (tibble)

• policies (list)

• attached_policies (list)

• groups (list)

Note

if username not supplied, gets logged in user

See Also

Other users: aws_user_access_key(), aws_user_access_key_delete(), aws_user_add_to_group(), aws_user_create(), aws_user_current(), aws_user_delete(), aws_user_exists(), aws_users(), six_user_create(), six_user_delete()

Examples

## Not run: 
# if username not supplied, gets the logged in user
aws_user()

## End(Not run)


if (aws_user_exists("testBlueBird")) {
  aws_user_delete("testBlueBird")
}
aws_user_create("testBlueBird")
aws_user("testBlueBird")

# cleanup
aws_user_delete("testBlueBird")

Description

IMPORTANT: the secret access key is only accessible during key and user creation

Usage

aws_user_access_key(username = NULL, ...)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_list_access_keys/ docs for more details

Value

a tibble with key details

See Also

Other users: aws_user(), aws_user_access_key_delete(), aws_user_add_to_group(), aws_user_create(), aws_user_current(), aws_user_delete(), aws_user_exists(), aws_users(), six_user_create(), six_user_delete()

Description

Delete current user's AWS Access Key

Usage

aws_user_access_key_delete(access_key_id, username = NULL)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_delete_access_key/ docs for more details

Value

NULL, invisibly

See Also

Other users: aws_user(), aws_user_access_key(), aws_user_add_to_group(), aws_user_create(), aws_user_current(), aws_user_delete(), aws_user_exists(), aws_users(), six_user_create(), six_user_delete()

Description

Add or remove a user to/from a group

Usage

aws_user_add_to_group(username, groupname)

aws_user_remove_from_group(username, groupname)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_add_user_to_group/ https://www.paws-r-sdk.com/docs/iam_remove_user_from_group/ docs for more details

Value

a named list with slots for:

• user (tibble)

• policies (list)

• attached_policies (list)

• groups (list)

See Also

Other users: aws_user(), aws_user_access_key(), aws_user_access_key_delete(), aws_user_create(), aws_user_current(), aws_user_delete(), aws_user_exists(), aws_users(), six_user_create(), six_user_delete()

Examples

group1 <- random_string("group")
if (!aws_group_exists(group1)) {
  aws_group_create(group1)
}
name1 <- random_user()
if (!aws_user_exists(name1)) {
  aws_user_create(name1)
}
aws_user_add_to_group(name1, group1)
aws_group(group1) # has user name1
aws_user_remove_from_group(name1, group1)
aws_group(group1) # does not have user name1

Description

Create a user

Usage

aws_user_create(username, path = NULL, permission_boundary = NULL, tags = NULL)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_create_user/ docs for details on the parameters

Value

A tibble with information about the user created

See Also

Other users: aws_user(), aws_user_access_key(), aws_user_access_key_delete(), aws_user_add_to_group(), aws_user_current(), aws_user_delete(), aws_user_exists(), aws_users(), six_user_create(), six_user_delete()

Examples

user1 <- random_user()
if (aws_user_exists(user1)) {
  aws_user_delete(user1)
}
aws_user_create(user1)

# cleanup
aws_user_delete(user1)

Description

Get the current logged-in username as a string

Usage

aws_user_current()

Value

username as character, scalar

See Also

Other users: aws_user(), aws_user_access_key(), aws_user_access_key_delete(), aws_user_add_to_group(), aws_user_create(), aws_user_delete(), aws_user_exists(), aws_users(), six_user_create(), six_user_delete()

Description

Delete a user

Usage

aws_user_delete(username)

Arguments

Details

See https://www.paws-r-sdk.com/docs/iam_delete_user/ docs for more details

Value

NULL invisibly

See Also

Other users: aws_user(), aws_user_access_key(), aws_user_access_key_delete(), aws_user_add_to_group(), aws_user_create(), aws_user_current(), aws_user_exists(), aws_users(), six_user_create(), six_user_delete()

Examples

user_name <- random_user()
aws_user_create(user_name)
aws_user_delete(user_name)
aws_user_exists(user_name)

Description

Check if a user exists

Usage

aws_user_exists(username)

Arguments

Details

uses aws_user() internally. see docs https://www.paws-r-sdk.com/docs/iam_get_user/

Value

a single boolean

See Also

Other users: aws_user(), aws_user_access_key(), aws_user_access_key_delete(), aws_user_add_to_group(), aws_user_create(), aws_user_current(), aws_user_delete(), aws_users(), six_user_create(), six_user_delete()

Examples

aws_user_exists(aws_user_current())
aws_user_exists("doesnotexist")

Description

List Users

Usage

aws_users(...)

Arguments

Value

A tibble with information about user accounts, with columns:

• UserName

• UserId

• Path

• Arn

• CreateDate

• PasswordLastUsed

See Also

Other users: aws_user(), aws_user_access_key(), aws_user_access_key_delete(), aws_user_add_to_group(), aws_user_create(), aws_user_current(), aws_user_delete(), aws_user_exists(), six_user_create(), six_user_delete()

Examples

aws_users()

Description

Get a VPC by id

Usage

aws_vpc(id, ...)

Arguments

Value

(list) with fields:

• Vpcs (list) each VPC group

• NextToken (character) token for paginating

Each element of Vpcs is a list with slots:

• CidrBlock

• DhcpOptionsId

• State

• VpcId

• OwnerId

• InstanceTenancy

• Ipv6CidrBlockAssociationSet

• CidrBlockAssociationSet

• IsDefault

• Tags

Description

Modify security group rules

Usage

aws_vpc_sec_group_rules_mod(id, rules, ...)

Arguments

Value

list. if successful then list(Return=TRUE)

See Also

Other security groups: aws_vpc_security_group(), aws_vpc_security_group_create(), aws_vpc_security_group_ingress(), aws_vpc_security_groups(), aws_vpc_sg_with_ingress()

Examples

# create a security group
a_grp_name <- random_string("vpcsecgroup")
x <- aws_vpc_security_group_create(name = a_grp_name)
x

# add an inbound rule
my_rule <- aws_vpc_security_group_ingress(
  id = x$GroupId,
  ip_permissions = ip_permissions_generator("mariadb")
)
my_rule

# modify the rule
rule_id <- my_rule$SecurityGroupRules[[1]]$SecurityGroupRuleId
fields_to_keep <- c(
  "IpProtocol", "FromPort", "ToPort", "CidrIpv4",
  "CidrIpv6", "PrefixListId", "Description"
)
rule_old <- my_rule$SecurityGroupRules[[1]]
rule_new <- rule_old[fields_to_keep]
rule_new$Description <- "Modified description"

aws_vpc_sec_group_rules_mod(
  id = x$GroupId,
  rules = list(
    SecurityGroupRuleId = rule_id,
    SecurityGroupRule = rule_new
  )
)

# cleanup
aws_vpc_security_group_delete(name = a_grp_name)

Description

Get a security group by ID

Usage

aws_vpc_security_group(id, ...)

Arguments

Value

(list) with fields:

• SecurityGroups (list) each security group

  • Description

  • GroupName

  • IpPermissions

  • OwnerId

  • GroupId

  • IpPermissionsEgress

  • Tags

  • VpcId

• NextToken (character) token for paginating

See Also

Other security groups: aws_vpc_sec_group_rules_mod(), aws_vpc_security_group_create(), aws_vpc_security_group_ingress(), aws_vpc_security_groups(), aws_vpc_sg_with_ingress()

Description

Create a security group

Usage

aws_vpc_security_group_create(
  name,
  engine = "mariadb",
  description = NULL,
  vpc_id = NULL,
  tags = NULL,
  ...
)

aws_vpc_security_group_delete(id = NULL, name = NULL, ...)

Arguments

Value

(list) with fields:

• GroupId (character)

• Tags (list)

See Also

Other security groups: aws_vpc_sec_group_rules_mod(), aws_vpc_security_group(), aws_vpc_security_group_ingress(), aws_vpc_security_groups(), aws_vpc_sg_with_ingress()

Examples

## Not run: 
# create security group
grp_name1 <- random_string("vpcsecgroup")
x <- aws_vpc_security_group_create(
  name = grp_name1,
  description = "Testing security group creation"
)

grp_name2 <- random_string("vpcsecgroup")
aws_vpc_security_group_create(name = grp_name2)

grp_name3 <- random_string("vpcsecgroup")
aws_vpc_security_group_create(
  name = grp_name3,
  tags = list(
    list(
      ResourceType = "security-group",
      Tags = list(
        list(
          Key = "sky",
          Value = "blue"
        )
      )
    )
  )
)

# add ingress
aws_vpc_security_group_ingress(
  id = x$GroupId,
  ip_permissions = ip_permissions_generator("mariadb")
)

# cleanup
aws_vpc_security_group_delete(name = grp_name1)
aws_vpc_security_group_delete(name = grp_name2)
aws_vpc_security_group_delete(name = grp_name3)

## End(Not run)

Description

Authorize Security Group Ingress

Usage

aws_vpc_security_group_ingress(id, ip_permissions = NULL, ...)

Arguments

Value

list with slots:

• Return (boolean)

• SecurityGroupRules (list)

  • SecurityGroupRuleId

  • GroupId

  • GroupOwnerId

  • IsEgress

  • IpProtocol

  • FromPort

  • ToPort

  • CidrIpv4

  • CidrIpv6

  • PrefixListId

  • ReferencedGroupInfo

  • Description

  • Tags

See Also

Other security groups: aws_vpc_sec_group_rules_mod(), aws_vpc_security_group(), aws_vpc_security_group_create(), aws_vpc_security_groups(), aws_vpc_sg_with_ingress()

Description

List VPC security groups

Usage

aws_vpc_security_groups(...)

Arguments

Value

(list) list with security groups, see aws_vpc_security_group() for details

See Also

Other security groups: aws_vpc_sec_group_rules_mod(), aws_vpc_security_group(), aws_vpc_security_group_create(), aws_vpc_security_group_ingress(), aws_vpc_sg_with_ingress()

Examples

aws_vpc_security_groups()
aws_vpc_security_groups(MaxResults = 6)

Description

Get a security group with one ingress rule based on the engine

Usage

aws_vpc_sg_with_ingress(engine)

Arguments

Details

Adds an ingress rule specific to the engine supplied (port changes based on the engine), and your IP address. To create your own security group and ingress rules see aws_vpc_security_group_create() and aws_vpc_security_group_ingress()

Value

(character) security group ID

See Also

Other security groups: aws_vpc_sec_group_rules_mod(), aws_vpc_security_group(), aws_vpc_security_group_create(), aws_vpc_security_group_ingress(), aws_vpc_security_groups()

Description

List VPCs

Usage

aws_vpcs(...)

Arguments

Value

(list) list with VPCs, see aws_vpc() for details

Examples

aws_vpcs()
aws_vpcs(MaxResults = 6)

Description

Get bucket ARN

Usage

bucket_arn(bucket, objects = "")

Arguments

Value

character string of bucket arn

Examples

bucket_arn("somebucket")
bucket_arn("somebucket", objects = "*")
bucket_arn("somebucket", objects = "data.csv")
bucket_arn("somebucket", objects = "myfolder/subset/data.csv")
bucket_arn("somebucket", objects = "myfolder/subset/*")

Description

Get a paws client for a service

Usage

con_iam()

con_s3()

con_sm()

con_ec2()

con_rds()

con_redshift()

con_ce()

Details

Toggles the credentials used based on the environment variable AWS_PROFILE for one of: minio, localstack, aws.

If AWS_PROFILE is "minio" then we set the following in the credentials for the connection:

• access_key_id uses env var MINIO_USER, with default "minioadmin"

• secret_access_key uses env var MINIO_PWD, with default "minioadmin"

• endpoint uses env var MINIO_ENDPOINT, with default "http://127.0.0.1:9000"

If AWS_PROFILE is "localstack" then we set the following in the credentials for the connection:

• access_key_id uses env var LOCALSTACK_KEY, with a default string which is essentially ignored. you do not need to set the LOCALSTACK_KEY env var. However, if you want to set an account ID for your Localstack you can set the env var and it will be used. see https://docs.localstack.cloud/references/credentials/

• secret_access_key uses env var LOCALSTACK_SECRET, with a default string which is ignored; and any value you set for LOCALSTACK_SECRET will be ignored by Localstack as well. see https://docs.localstack.cloud/references/credentials/

• endpoint uses env var LOCALSTACK_ENDPOINT. You can set this to the URL for where your Localstack is running at. Default is ⁠http://localhost.localstack.cloud:4566⁠

If AWS_PROFILE is not set, set to "aws", or anything else (other than "localstack") then we don't set any credentials internally, but paws will gather any credentials you've set via env vars, config files, etc.-

Value

• con_s3: a list with methods for interfacing with S3; https://www.paws-r-sdk.com/docs/s3/

• con_iam: a list with methods for interfacing with IAM; https://www.paws-r-sdk.com/docs/iam/

• con_sm: a list with methods for interfacing with Secrets Manager; https://www.paws-r-sdk.com/docs/secretsmanager/

• con_ec2: a list with methods for interfacing with EC2; https://www.paws-r-sdk.com/docs/ec2/

• con_rds: a list with methods for interfacing with RDS; https://www.paws-r-sdk.com/docs/rds/

• con_redshift: a list with methods for interfacing with Redshift; https://www.paws-r-sdk.com/docs/redshift/

• con_ce: a list with methods for interfacing with Cost Explorer; https://www.paws-r-sdk.com/docs/costexplorer/

See Also

con_s3fs()

Examples

z <- con_iam()
z

withr::with_envvar(
  c("AWS_PROFILE" = "localstack"),
  con_iam()
)
withr::with_envvar(
  c("AWS_PROFILE" = "minio"),
  con_s3()
)

Description

s3fs connection

Usage

con_s3fs()

Details

we set refresh=TRUE on s3fs::s3_file_system() so that you can change the s3 interface within an R session

You can toggle the interface set for one of minio, localstack, aws. See connections for more information.

Value

An S3 list with class 'sixtyfour_client'

See Also

paws_clients

Examples

con <- con_s3fs()
con
con_s3fs()$file_copy

Description

Figure out policy Arn from a name

Usage

figure_out_policy_arn(name)

Arguments

Value

NULL when not found; otherwise an ARN string

Examples

# aws managed
figure_out_policy_arn("AmazonS3ReadOnlyAccess")
# aws managed, job function
figure_out_policy_arn("Billing")
figure_out_policy_arn("DataScientist")
# doesn't exist
figure_out_policy_arn("DoesNotExist")

Description

Preset group policies

Usage

group_policies(group)

Arguments

Value

character vector of policy names

Admin group policies

• AdministratorAccess

• Billing

• CostOptimizationHubAdminAccess

• AWSBillingReadOnlyAccess

• AWSCostAndUsageReportAutomationPolicy

User group policies

• AmazonRDSReadOnlyAccess

• AmazonRedshiftReadOnlyAccess

• AmazonS3ReadOnlyAccess

• AWSBillingReadOnlyAccess

• IAMReadOnlyAccess

Examples

group_policies("admin")
group_policies("users")

Description

Ip Permissions generator

Usage

ip_permissions_generator(engine, port = NULL, description = NULL)

Arguments

Value

a list with slots: FromPort, ToPort, IpProtocol, and IpRanges

Description

Get a random string, bucket name, user name or role name

Usage

random_string(prefix, size = 8)

random_bucket(prefix = "bucket-", size = 16)

random_user()

random_role()

Arguments

Value

• random_string: (character) a string with prefix at beginning

• random_bucket: (character) a bucket name prefixed with prefix (default: "bucket-")

• random_user/random_role: (character) a user or role name with a random adjective plus a random noun combined into one string, shortened to no longer than 16 characters, if longer than 16

Examples

random_string("group-")
replicate(10, random_string("group-"))
random_bucket()
replicate(10, random_bucket())
random_user()
replicate(10, random_user())
random_role()
replicate(10, random_role())

Description

Create a resource string for a policy statement for RDS

Usage

resource_rds(
  user,
  resource_id,
  region = Sys.getenv("AWS_REGION"),
  account = account_id()
)

Arguments

Value

a resource ARN (scalar, character)

Description

S3 actions for full access (read and write), from the AWS managed policy AmazonS3FullAccess

Usage

s3_actions_full()

Value

character vector of actions

Examples

s3_actions_full()

Description

S3 actions for reading, from the AWS managed policy AmazonS3ReadOnlyAccess

Usage

s3_actions_read()

Value

character vector of actions

Examples

s3_actions_read()

Description

Mapping of full names of AWS services to acronyms

Usage

service_map

Format

service_map

A data frame with 178 rows and 2 columns:

service

Service name in full

acronym

The acronym, from 2 to 5 characters in length

...

Source

https://tommymaynard.com/aws-service-acronyms/

Description

AWS account setup for administrators

Usage

six_admin_setup(users_group = "users", admin_group = "admin")

Arguments

Value

NULL invisibly

What is magical

• Setup a users IAM group: users that do not require admin persmissions

• Add policies to the users group

• Setup an admin IAM group: users that require admin permissions

• Add policies to the admin group

See Also

Other magicians: six_bucket_delete(), six_bucket_upload(), six_file_upload(), six_user_create(), six_user_delete()