Skip to content

Return an authentication token for a database connection

Description

Return an authentication token used as the password for a database connection.

Usage

rds_build_auth_token(endpoint, user, creds = NULL, region = NULL)

Arguments

  • endpoint

    [required] Hostname and port needed to connect to the database: <host>:<port>.

  • user

    [required] User account within the database to sign in with.

  • creds

    Credentials to be signed with.

  • region

    AWS region the database is located in.

Details

See IAM Database Authentication for MySQL and PostgreSQL for more information on using IAM database authentication with RDS.

See Also

rds_build_auth_token_v2

Request syntax

svc$build_auth_token(
  endpoint = "string",
  region = "string",
  user = "string",
  creds = list(
    access_key_id = "string",
    secret_access_key = "string",
    session_token = "string"
  )
)

Examples

# This example gets an authentication token for an RDS database, then
# connects to the database using the token.
host <- "database-1.cluster-abcdef123456.us-east-1.rds.amazonaws.com"
port <- 3306
user <- "jane_doe"
token <- svc$build_auth_token(
  endpoint = sprintf("%s:%s", host, port),
  region = "us-east-1",
  user = user
)
conn <- DBI::dbConnect(
  drv = RMariaDB::MariaDB(),
  user = user,
  password = token,
  host = host,
  port = port,
  client.flag = RMariaDB::CLIENT_SSL
)