Skip to content

Commit 5996468

Browse files
committed
Minor - Adjusting redshift connect docs with example
1 parent 563e402 commit 5996468

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Easy integration with Athena, Glue, Redshift, Timestream, QuickSight, Chime, Clo
1616
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
1717
[![Coverage](https://img.shields.io/badge/coverage-91%25-brightgreen.svg)](https://pypi.org/project/awswrangler/)
1818
![Static Checking](https://github.com/awslabs/aws-data-wrangler/workflows/Static%20Checking/badge.svg?branch=main)
19-
![Build Status](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiL05FNGxiZCtNT05ibGUrbzY5TzJxaFlOcnFrUFlyNjhWRm5tTmg1bXJXRkdnYUFySzgycEUvMTBBbWxEUzZ2eUpOdjVpcmNQV2hsNkRzQTZtTTVwSjF3PSIsIml2UGFyYW1ldGVyU3BlYyI6IkQ1RVkxWjg5YloyaTJOcVgiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main)
2019
[![Documentation Status](https://readthedocs.org/projects/aws-data-wrangler/badge/?version=latest)](https://aws-data-wrangler.readthedocs.io/?badge=latest)
2120

2221
| Source | Downloads | Installation Command |

awswrangler/redshift.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,16 @@ def connect(
379379
380380
Note
381381
----
382-
You MUST pass a `connection` OR `secret_id`
382+
You MUST pass a `connection` OR `secret_id`.
383+
Here is an example of the secret structure in Secrets Manager:
384+
{
385+
"host":"my-host.us-east-1.redshift.amazonaws.com",
386+
"username":"test",
387+
"password":"test",
388+
"engine":"redshift",
389+
"port":"5439",
390+
"dbname": "mydb"
391+
}
383392
384393
385394
https://github.com/aws/amazon-redshift-python-driver

0 commit comments

Comments
 (0)