Fork me on GitHub

Database Access Getting Started Guide


In this getting started guide we will use Teleport Database Access to connect to a PostgreSQL AWS Aurora database.

Here's an overview of what we will do:

  1. Configure an AWS Aurora database with IAM authentication.
  2. Join the Aurora database to your Teleport cluster.
  3. Connect to the Aurora database via the Teleport Database Service.

Teleport Database Access RDS Self-Hosted


Supported versions

Teleport Database Access is available starting from the 6.0.0 Teleport release.

  • An AWS account with a PostgreSQL AWS Aurora database and permissions to create and attach IAM policies.
  • A host, e.g., an EC2 instance, where you will run the Teleport Database Service.
  • The tsh client tool version >= 9.2.3.

    tsh version

    Teleport v9.2.3 go1.17

    See Installation for details.

  • A host where you will install the Teleport Auth Service and Proxy Service.

  • A registered domain name.

  • The tsh client tool version >= 9.2.3, which you can download by visiting the customer portal.

    tsh version

    Teleport v9.2.3 go1.17

  • A host where you will install the Teleport Auth Service and Proxy Service.

  • A registered domain name.

  • The tctl and tsh client tools version >= 9.1.2.

    You can download these from Teleport Cloud Downloads.

    tctl version

    Teleport v9.1.2 go1.17

    tsh version

    Teleport v9.1.2 go1.17

Verify that your Teleport client is connected by running the following on your Auth Service host:

tctl status


Version 9.2.3

CA pin sha256:sha-hash-here

Remain logged in to your Auth Service host so you can run subsequent tctl commands in this guide.

To connect to Teleport, log in to your cluster using tsh, then use tctl remotely:

tsh login [email protected]
tctl status


Version 9.1.2

CA pin sha256:sha-hash-here

You must run subsequent tctl commands in this guide on your local machine.

Step 1/3. Set up Aurora

In order to allow Teleport connections to an Aurora instance, the instance needs to support IAM authentication.

If you don't have a database provisioned yet, create an instance of an Aurora PostgreSQL in the RDS control panel. Make sure to choose the "Standard create" database creation method and enable "Password and IAM database authentication" in the Database Authentication dialog.

For existing Aurora instances, the status of IAM authentication is displayed on the Configuration tab and can be enabled by modifying the database instance.

Next, create the following IAM policy and attach it to the AWS user or service account. The Teleport Database Service will need to use the credentials of this AWS user or service account in order to use this policy.

   "Version": "2012-10-17",
   "Statement": [
         "Effect": "Allow",
         "Action": [
         "Resource": [

This policy allows any database account to connect to the Aurora instance specified with resource ID using IAM auth.

Resource ID

The database resource ID is shown on the Configuration tab of a particular database instance in the RDS control panel, under "Resource id". For regular RDS database it starts with db- prefix. For Aurora, use the database cluster resource ID (cluster-), not the individual instance ID.

Finally, connect to the database and create a database account with IAM auth support (or update an existing one). Once connected, execute the following SQL statements to create a new database account and allow IAM auth for it:

GRANT rds_iam TO alice;

For more information about connecting to the PostgreSQL instance directly, see the AWS documentation.

Step 2/3. Set up Teleport

Start the Auth Service and Proxy Service

On the host where you will run the Auth Service and Proxy Service, download the latest version of Teleport for your platform from our downloads page and follow the installation instructions.

Teleport requires a valid TLS certificate to operate and can fetch one automatically using Let's Encrypt's ACME protocol. Before Let's Encrypt can issue a TLS certificate for the Teleport Proxy host's domain, the ACME protocol must verify that an HTTPS server is reachable on port 443 of the host.

You can configure the Teleport Proxy service to complete the Let's Encrypt verification process when it starts up.

Run the following teleport configure command, where is the domain name of your Teleport cluster and [email protected] is an email address used for notifications (you can use any domain):

teleport configure --acme [email protected] > /etc/teleport.yaml

The --acme, --acme-email, and --cluster-name flags will add the following settings to your Teleport configuration file:

  enabled: "yes"
  web_listen_addr: :443
    enabled: "yes"
    email: [email protected]

Port 443 on your Teleport Proxy Service host must allow traffic from all sources.

Next, start the Teleport Auth and Proxy Services:

sudo teleport start

You will run subsequent tctl commands on the host where you started the Auth and Proxy Services.

If you do not have a Teleport Cloud account, use our signup form to get started. Teleport Cloud manages instances of the Proxy Service and Auth Service, and automatically issues and renews the required TLS certificate.

You must log in to your cluster before you can run tctl commands.

tsh login
tctl status

Start the Teleport Database Service

The Database Service requires a valid auth token to connect to the cluster. Generate one by running the following command against your Teleport Auth Service and save it in /tmp/token on the node that will run the Database Service:

tctl tokens add --type=db

Install Teleport on the host where you will run the Teleport Database Service:

Download Teleport's PGP public key

sudo curl \ -o /usr/share/keyrings/teleport-archive-keyring.asc

Add the Teleport APT repository

echo "deb [signed-by=/usr/share/keyrings/teleport-archive-keyring.asc] stable main" \| sudo tee /etc/apt/sources.list.d/teleport.list > /dev/null
sudo apt-get update
sudo apt-get install teleport
sudo yum-config-manager --add-repo
sudo yum install teleport

Optional: Using DNF on newer distributions

$ sudo dnf config-manager --add-repo

$ sudo dnf install teleport


<checksum> <filename>

curl -O
shasum -a 256 teleport-v9.2.3-linux-amd64-bin.tar.gz

Verify that the checksums match

tar -xzf teleport-v9.2.3-linux-amd64-bin.tar.gz
cd teleport
sudo ./install

<checksum> <filename>

curl -O
shasum -a 256 teleport-v9.2.3-linux-arm-bin.tar.gz

Verify that the checksums match

tar -xzf teleport-v9.2.3-linux-arm-bin.tar.gz
cd teleport
sudo ./install

<checksum> <filename>

curl -O
shasum -a 256 teleport-v9.2.3-linux-arm64-bin.tar.gz

Verify that the checksums match

tar -xzf teleport-v9.2.3-linux-arm64-bin.tar.gz
cd teleport
sudo ./install

On the node where you will run the Teleport Database Service, start Teleport and point it to your Aurora database instance. Make sure to update the database endpoint and region appropriately. The --auth-server flag must point to the address of your Teleport Proxy Service.

teleport db start \ --token=/tmp/token \ --db-name=aurora \ \ --db-protocol=postgres \ \ --db-aws-region=us-west-1
AWS Credentials

The node that connects to the database should have AWS credentials configured with the policy from step 1.

Create a user and role

Create the role that will allow a user to connect to any database using any database account:

tctl create <<EOFkind: roleversion: v3metadata: name: dbspec: allow: db_labels: '*': '*' db_names: - '*' db_users: - '*'EOF

Create the Teleport user assigned the db role we've just created:

tctl users add --roles=access,db alice

Step 3/3. Connect

Now that Aurora is configured with IAM authentication, Teleport is running, and the local user is created, we're ready to connect to the database.

Log in to Teleport with the user we've just created.

tsh login --user=alice

Now we can inspect available databases and retrieve credentials for the configured Aurora instance:

tsh db ls
tsh db login aurora

Finally, connect to the database using the psql command shown in the output of the tsh db login command, which looks similar to this:

psql "service=<cluster>-aurora user=alice dbname=postgres"

Next Steps

For the next steps, dive deeper into the topics relevant to your Database Access use-case, for example: