Skip to content

Update README.md #3

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
alustau merged 2 commits into from
Jul 4, 2025
Merged

Update README.md #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da2c439
Update README.md
alustau Jun 4, 2025
2faa1d7
Merge branch 'main' into alustau-patch-1
alustau Jul 4, 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
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This library was inspired on [Laravel Aurora Connector](https://github.com/cgaug
## 🚀 Installation

```bash
composer customergauge/redshift
composer require customergauge/redshift
```

## ⚙️ Usage
Expand All @@ -30,11 +30,26 @@ In your `config/database.php`, define a connection using the `redshift` driver:
'options' => [],
'redshift' => [
'secret' => env('AWS_REDSHIFT_SECRET'), // optional
'temporary_credential' => [] // optional: IAM-based temporary auth
],
],
```

You can optionally configure a secret name for **AWS Secrets Manager** to securely fetch the credentials.
You can optionally configure a secret name for AWS **AWS Secrets Manager** via `redshift.secret` to securely fetch the database credentials.

Alternatively, if your application runs with sufficient IAM permissions, you can use temporary credentials to connect to Redshift.
To enable this, set the temporary_credential option in the redshift config:

```php
'temporary_credential' => [
'workgroupName' => 'your-redshift-workgroup-name', // mandatory to work
// You may also pass any valid parameters supported by AWS Redshift Serverless getCredentials API
],
```
When this option is enabled, the application will connect to Amazon Redshift using short-lived credentials obtained via AWS IAM authentication,
improving security by avoiding static passwords and enabling fine-grained access control.

**This requires your application (e.g. ECS task, Lambda, EC2, etc.) to assume an IAM role with permission to call redshift-serverless:GetCredentials**

## 🌍 AWS Configuration

Expand Down