Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to (link). These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access.
assume_role(
profile_name = NULL,
region_name = NULL,
role_arn = NULL,
role_session_name = sprintf("noctua-session-%s", as.integer(Sys.time())),
duration_seconds = 3600L,
set_env = FALSE
)The name of a profile to use. If not given, then the default profile is used. To set profile name, the AWS Command Line Interface (AWS CLI) will need to be configured. To configure AWS CLI please refer to: Configuring the AWS CLI.
Default region when creating new connections. Please refer to link for
AWS region codes (region code example: Region = EU (Ireland) region_name = "eu-west-1")
The Amazon Resource Name (ARN) of the role to assume (such as arn:aws:sts::123456789012:assumed-role/role_name/role_session_name)
An identifier for the assumed role session. By default `noctua` creates a session name sprintf("noctua-session-%s", as.integer(Sys.time()))
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. By default duration is set to 3600 seconds (1 hour).
If set to TRUE environmental variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN will be set.
assume_role() returns a list containing: "AccessKeyId", "SecretAccessKey", "SessionToken" and "Expiration"
if (FALSE) {
# Note:
# - Require AWS Account to run below example.
library(noctua)
library(DBI)
# Assuming demo ARN role
assume_role(
profile_name = "YOUR_PROFILE_NAME",
role_arn = "arn:aws:sts::123456789012:assumed-role/role_name/role_session_name",
set_env = TRUE
)
# Connect to Athena using ARN Role
con <- dbConnect(noctua::athena())
}