AWSTemporaryCredentials: AWS Temporary Root Credential Manager

Description Usage Arguments Format Details See Also

Description

R6 implementation of AWS Temporary Credential searches and management

AWSTemporaryCredentials$new( rootCredentials = NULL, roleArn = NULL, RoleSessionName = NULL, MFADeviceSerialNumber = NULL, Duration = "3600" )

AWSTemporaryCredentials$print() AWSTemporaryCredentials$hasExpired() AWSTemporaryCredentials$rotate()

Usage

1

Arguments

rootCredentials

(AWSRootCredentials) Your root credential object to feed STS calls

roleArn

(string) the ARN of the role you want to assume

MFADeviceSerialNumber

(string) The id number (serial | arn) of your MFA device.

Duration

(string) Duration, in seconds, of the role session; controls time-to-expire of temporary credentials.

Format

An object of class R6ClassGenerator of length 24.

Details

For additional information on STS requests refer to: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html Initializes a call to STS or pulls instance meta data. Exactly which depends on the arguments you pass.

  1. If root credentials are passed, it will call STS.

    • Only the root credentials and roleArn are required.

    • If you have an account with MFA, you must pass your MFA SN.

    • This only works with Assume Role for now, thus the requirement of a roleARN.

  2. Otherwise, it will try to curl instance metadata and get temporary credentials from there.

$print() similar behavior to AWSRootCredentials $hasExpired() boolean check of stale temporary credentials $rotate() invokes the initilization function again, but should retain knowledge of Root Credentials if used.

See Also

Other credential management functions: AWSRootCredentials, RcurlAWS, credsFromInstanceMetadata, genCredentialFilePath, getCredentials, getProfiles, getSTSCredentials, parseCredentialFile, stsGenContentString, tempCredentialHandler


AlonzoBarnett/RcurlAWS documentation built on May 15, 2019, 10:47 a.m.