add docs for RDS_CLUSTER_ENDPOINT_HOST_ONLY configuration

localstack · Oct 11, 2023 · c05f112 · c05f112
1 parent c89e9f6
commit c05f112
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/content/en/references/configuration.md b/content/en/references/configuration.md
@@ -219,10 +219,11 @@ The old lambda provider is temporarily available in Localstack&nbsp;v2 using `PR
 
 | Variable | Example Values | Description |
 | - | - | - |
-| `RDS_PG_CUSTOM_VERSIONS` | `0` / `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). |
-| `RDS_MYSQL_DOCKER`       | `0` (default) / `1` | Whether to enable MySQL engines (instead of MariaDB). Will run the MySQL cluster/instances in a new docker container. |
-| `MYSQL_IMAGE`            | `mysql:8.0`       | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if `RDS_MYSQL_DOCKER` is enabled. |
-| `MSSQL_IMAGE`            | `mcr.microsoft.com/mssql/server:2022-latest` | Defines a specific image that should be used when spinning up a SQL server engine. |
+| `RDS_CLUSTER_ENDPOINT_HOST_ONLY` | `0` (default) / `1` | Whether the cluster endpoint returns the host only (which is AWS parity). If set to `0` it will return `<host>:<port>`. |
+| `RDS_PG_CUSTOM_VERSIONS`         | `0` / `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). |
+| `RDS_MYSQL_DOCKER`               | `0` (default) / `1` | Whether to enable MySQL engines (instead of MariaDB). Will run the MySQL cluster/instances in a new docker container. |
+| `MYSQL_IMAGE`                    | `mysql:8.0`       | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if `RDS_MYSQL_DOCKER` is enabled. |
+| `MSSQL_IMAGE`                    | `mcr.microsoft.com/mssql/server:2022-latest` | Defines a specific image that should be used when spinning up a SQL server engine. |
 
 ### S3
 

diff --git a/content/en/user-guide/aws/rds/index.md b/content/en/user-guide/aws/rds/index.md
@@ -25,6 +25,11 @@ LocalStack's RDS implementation also supports the [RDS Data API](https://docs.aw
 
 ### Create an RDS cluster
 
+{{< alert title="Note" >}}
+The `Endpoint` for cluster on Localstack currently follows the pattern `<host>:<port>` for legacy reasons, which is not in parity in AWS. 
+To force the correct pattern (e.g. returning only the host for the `Endpoint`) you can use the configuration `RDS_CLUSTER_ENDPOINT_HOST_ONLY=1` to start LocalStack.
+{{< /alert >}}
+
 To create an RDS cluster, you can use the [`CreateDBCluster`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) API. 
 The following command creates a new cluster with the name `db1` and the engine `aurora-postgresql`. 
 Instances for the cluster must be added manually.