Skip to content

docs: clarify default behavior for REGION in AWS connections #33798

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
merged 2 commits into from
Oct 8, 2025
Merged

docs: clarify default behavior for REGION in AWS connections #33798

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ee0957
docs: clarify default behavior for REGION in AWS connections
bobbyiliev Oct 7, 2025
795aa45
docs: add REGION to AWS connection examples
bobbyiliev Oct 8, 2025
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
11 changes: 7 additions & 4 deletions doc/user/content/sql/create-connection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ perform [authentication with an Amazon RDS MySQL database](#mysql-aws-connection
| <div style="min-width:240px">Field</div> | Value | Description
|-------------------------------------------|------------------|------------------------------
| `ENDPOINT` | `text` | *Advanced.* Override the default AWS endpoint URL. Allows targeting S3-compatible services like MinIO.
| `REGION` | `text` | The AWS region to connect to.
| `REGION` | `text` | The AWS region to connect to. Defaults to the current Materialize region.
| `ACCESS KEY ID` | secret or `text` | The access key ID to connect with. Triggers credentials-based authentication.<br><br><strong>Warning!</strong> Use of credentials-based authentication is deprecated. AWS strongly encourages the use of role assumption-based authentication instead.
| `SECRET ACCESS KEY` | secret | The secret access key corresponding to the specified access key ID.<br><br>Required and only valid when `ACCESS KEY ID` is specified.
| `SESSION TOKEN` | secret or `text` | The session token corresponding to the specified access key ID.<br><br>Only valid when `ACCESS KEY ID` is specified.
Expand Down Expand Up @@ -147,7 +147,8 @@ To create an AWS connection that will assume the `WarehouseExport` role:

```mzsql
CREATE CONNECTION aws_role_assumption TO AWS (
ASSUME ROLE ARN = 'arn:aws:iam::000000000000:role/WarehouseExport'
ASSUME ROLE ARN = 'arn:aws:iam::000000000000:role/WarehouseExport',
REGION = 'us-east-1'
);
```
{{< /tab >}}
Expand Down Expand Up @@ -315,7 +316,8 @@ CREATE CONNECTION kafka_connection TO KAFKA (

```mzsql
CREATE CONNECTION aws_msk TO AWS (
ASSUME ROLE ARN = 'arn:aws:iam::000000000000:role/MaterializeMSK'
ASSUME ROLE ARN = 'arn:aws:iam::000000000000:role/MaterializeMSK',
REGION = 'us-east-1'
);

CREATE CONNECTION kafka_msk TO KAFKA (
Expand Down Expand Up @@ -734,7 +736,8 @@ an SSH bastion server to accept connections from Materialize, check [this guide]

```mzsql
CREATE CONNECTION aws_rds_mysql TO AWS (
ASSUME ROLE ARN = 'arn:aws:iam::000000000000:role/MaterializeRDS'
ASSUME ROLE ARN = 'arn:aws:iam::000000000000:role/MaterializeRDS',
REGION = 'us-west-1'
);

CREATE CONNECTION mysql_connection TO MYSQL (
Expand Down