De-emphasize RDS Proxy in RDI setup documentation#2807
Open
dimitarseykov-redis wants to merge 4 commits intoredis:mainfrom
Open
De-emphasize RDS Proxy in RDI setup documentation#2807dimitarseykov-redis wants to merge 4 commits intoredis:mainfrom
dimitarseykov-redis wants to merge 4 commits intoredis:mainfrom
Conversation
- Move RDS Proxy setup to optional collapsible section with warning - Recommend Lambda function approach for all database types - Add links to AWS docs and Redis Terraform solution - Update NLB instructions to support both direct connection and RDS Proxy - Reorder steps so ARNs are available before Lambda setup RDS Proxy is no longer recommended but remains available for customers who have specific requirements that necessitate it.
cmilesb
reviewed
Feb 20, 2026
| {{<note>}} | ||
| For RDS PostgreSQL and Aurora PostgreSQL, skip this step and proceed directly to [Create network load balancer](#create-network-load-balancer-rds) and configure it to connect directly to your database IP address. | ||
| {{</note>}} | ||
| <details> |
Contributor
There was a problem hiding this comment.
@dimitarseykov-redis - Do we really need to keep these instructions on the docs site? I think it may just be better to remove them unless you have some examples where using an RDS proxy would be better than a lambda function.
Contributor
Author
There was a problem hiding this comment.
Some customers still insist on using RDS Proxy. That's why I suggest having it present in the docs, but hidden.
cmilesb
reviewed
Feb 20, 2026
|
|
||
| For more details on AWS PrivateLink, see [Share your services through AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html). | ||
|
|
||
| ### Set up Lambda function connectivity {#setup-lambda-function} |
Contributor
There was a problem hiding this comment.
I'd like to write out the exact steps here if possible, especially if this is our preferred solution over the RDS proxy.
- Add step-by-step instructions for deploying the aws-rds-lambda module - Include prerequisites section with Terraform and AWS CLI requirements - Add required variables table with descriptions and where to find each value - Document how the Lambda failover mechanism works - Add verification steps to confirm successful deployment - Include options for full infrastructure deployment and manual setup
- Create new hidden page at /operate/rc/databases/rdi/rds-proxy with RDS Proxy setup instructions - Remove collapsible <details> section from main setup page - Add note linking to the hidden RDS Proxy page for customers who need it - Simplify NLB instructions to focus on direct database connection - RDS Proxy page uses hidden: true frontmatter to exclude from navigation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the RDI setup documentation to de-emphasize RDS Proxy and recommend the Lambda function approach instead.
Changes
<details>section with a clear warning that it's not recommendedRationale
Related
Jira: RDSC-4604
Pull Request opened by Augment Code with guidance from the PR author
Note
Low Risk
Low risk because this PR only changes documentation content and links, with no product or infrastructure code changes.
Overview
RDI setup docs now steer users away from RDS Proxy by removing it from the main RDS/Aurora PrivateLink steps, updating the NLB target guidance to register the database IP, and adding a note that RDS Proxy is not recommended and does not work with PostgreSQL.
Adds a new hidden
rds-proxy.mdpage that documents RDS Proxy setup (with strong warnings), and adds a new#setup-lambda-functionsection describing the recommended Lambda-based failover approach, including a Redis-provided Terraform module and related deployment/verification guidance.Written by Cursor Bugbot for commit a3bfef7. This will update automatically on new commits. Configure here.