Skip to content

[v12] [docs] clarify RDS/Aurora databases getting modified #33412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
greedy52 merged 2 commits into from
Oct 16, 2023
Merged

[v12] [docs] clarify RDS/Aurora databases getting modified #33412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba30e3c
[docs] clarify RDS/Aurora databases getting modified (#33312)
greedy52 Oct 12, 2023
40b2262
fix missing req
greedy52 Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/pages/database-access/guides/rds.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ This guide will help you to:

- AWS account with RDS and Aurora databases and permissions to create and attach
IAM policies.
<Admonition type="warning" title="IAM authentication">
Your RDS and Aurora databases must have password and IAM authentication
enabled.

If IAM authentication is not enabled on the target RDS and Aurora databases,
the Database Service will attempt to enable IAM authentication by modifying
them using respective APIs.
</Admonition>
- A host, e.g., an EC2 instance, where you will run the Teleport Database
Service.
- (!docs/pages/includes/tctl.mdx!)
Expand Down Expand Up @@ -82,6 +90,13 @@ Service access to AWS credentials.

(!docs/pages/includes/database-access/aws-bootstrap.mdx!)

<Admonition type="note">
Teleport uses `rds:ModifyDBInstance` and `rds:ModifyDBCluster` to automatically
enable IAM authentication on the RDS instance and the Aurora cluster,
respectively. You can omit these permissions if IAM authentication is already
enabled.
</Admonition>

## Step 4/6. Start the Database Service

(!docs/pages/includes/start-teleport.mdx service="the Database Service"!)
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/reference/aws.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ policies for each discovery type are shown below.
</Tabs>

<Admonition type="note">
Teleport uses `rds:ModifyDBInstance` and `rds:DescribeDBClusters` to
Teleport uses `rds:ModifyDBInstance` and `rds:ModifyDBCluster` to
automatically enable [IAM
authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
on the RDS instance and the Aurora cluster, respectively. You can omit these
Expand Down