From ee5b4a37027b21673f3d6af3a934e69ade5476d0 Mon Sep 17 00:00:00 2001 From: "Thomas J. Leeper" Date: Fri, 25 May 2018 09:24:07 +0100 Subject: [PATCH] update README w/ pointer to aws.signature docs --- DESCRIPTION | 2 +- README.Rmd | 28 +++++----------------------- README.md | 28 +++++----------------------- 3 files changed, 11 insertions(+), 47 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index e095b24..c07f31d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: aws.s3 Type: Package Title: 'AWS S3' Client Package Version: 0.3.12 -Date: 2018-04-16 +Date: 2018-05-25 Authors@R: c(person("Thomas J.", "Leeper", role = c("aut", "cre"), email = "thosjleeper@gmail.com", comment = c(ORCID = "0000-0003-4097-6326")), diff --git a/README.Rmd b/README.Rmd index d2786f4..3a6f2a2 100644 --- a/README.Rmd +++ b/README.Rmd @@ -4,33 +4,15 @@ To use the package, you will need an AWS account and to enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. The [**aws.iam** package](https://github.com/cloudyr/aws.iam) profiles tools for working with IAM, including creating roles, users, groups, and credentials programmatically; it is not needed to *use* IAM credentials. -By default, all **cloudyr** packages for AWS services allow the use of credentials specified in a number of ways, beginning with: - - 1. User-supplied values passed directly to functions. - 2. Environment variables, which can alternatively be set on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). Or they can be set within R: - - ```R - Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey", - "AWS_SECRET_ACCESS_KEY" = "mysecretkey", - "AWS_DEFAULT_REGION" = "us-east-1", - "AWS_SESSION_TOKEN" = "mytoken") - ``` - 3. If R is running an EC2 instance, the role profile credentials provided by [**aws.ec2metadata**](https://cran.r-project.org/package=aws.ec2metadata). - 4. Profiles saved in a `/.aws/credentials` "dot file" in the current working directory. The `"default" profile is assumed if none is specified. - 5. [A centralized `~/.aws/credentials` file](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs), containing credentials for multiple accounts. The `"default" profile is assumed if none is specified. - -Profiles stored locally or in a centralized location (e.g., `~/.aws/credentials`) can also be invoked via: +A detailed description of how credentials can be specified is provided at: https://github.com/cloudyr/aws.signature/. The easiest way is to simply set environmetn variables on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). Or they can be set within R: ```R -# use your 'default' account credentials -aws.signature::use_credentials() - -# use an alternative credentials profile -aws.signature::use_credentials(profile = "bob") +Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey", + "AWS_SECRET_ACCESS_KEY" = "mysecretkey", + "AWS_DEFAULT_REGION" = "us-east-1", + "AWS_SESSION_TOKEN" = "mytoken") ``` -Temporary session tokens are stored in environment variable `AWS_SESSION_TOKEN` (and will be stored there by the `use_credentials()` function). The [aws.iam package](https://github.com/cloudyr/aws.iam/) provides an R interface to IAM roles and the generation of temporary session tokens via the security token service (STS). - To use the package with S3-compatible storage provided by other cloud platforms, set the `AWS_S3_ENDPOINT` environment variable to the appropriate host name. By default, the package uses the AWS endpoint: `s3.amazonaws.com` diff --git a/README.md b/README.md index d2786f4..3a6f2a2 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,15 @@ To use the package, you will need an AWS account and to enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. The [**aws.iam** package](https://github.com/cloudyr/aws.iam) profiles tools for working with IAM, including creating roles, users, groups, and credentials programmatically; it is not needed to *use* IAM credentials. -By default, all **cloudyr** packages for AWS services allow the use of credentials specified in a number of ways, beginning with: - - 1. User-supplied values passed directly to functions. - 2. Environment variables, which can alternatively be set on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). Or they can be set within R: - - ```R - Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey", - "AWS_SECRET_ACCESS_KEY" = "mysecretkey", - "AWS_DEFAULT_REGION" = "us-east-1", - "AWS_SESSION_TOKEN" = "mytoken") - ``` - 3. If R is running an EC2 instance, the role profile credentials provided by [**aws.ec2metadata**](https://cran.r-project.org/package=aws.ec2metadata). - 4. Profiles saved in a `/.aws/credentials` "dot file" in the current working directory. The `"default" profile is assumed if none is specified. - 5. [A centralized `~/.aws/credentials` file](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs), containing credentials for multiple accounts. The `"default" profile is assumed if none is specified. - -Profiles stored locally or in a centralized location (e.g., `~/.aws/credentials`) can also be invoked via: +A detailed description of how credentials can be specified is provided at: https://github.com/cloudyr/aws.signature/. The easiest way is to simply set environmetn variables on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). Or they can be set within R: ```R -# use your 'default' account credentials -aws.signature::use_credentials() - -# use an alternative credentials profile -aws.signature::use_credentials(profile = "bob") +Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey", + "AWS_SECRET_ACCESS_KEY" = "mysecretkey", + "AWS_DEFAULT_REGION" = "us-east-1", + "AWS_SESSION_TOKEN" = "mytoken") ``` -Temporary session tokens are stored in environment variable `AWS_SESSION_TOKEN` (and will be stored there by the `use_credentials()` function). The [aws.iam package](https://github.com/cloudyr/aws.iam/) provides an R interface to IAM roles and the generation of temporary session tokens via the security token service (STS). - To use the package with S3-compatible storage provided by other cloud platforms, set the `AWS_S3_ENDPOINT` environment variable to the appropriate host name. By default, the package uses the AWS endpoint: `s3.amazonaws.com`