Skip to content

Commit

Permalink
Add information on aws_rds_iam_token in README
Browse files Browse the repository at this point in the history
  • Loading branch information
onno-vos-dev committed Sep 20, 2024
1 parent 48e9c98 commit 82b2198
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,18 @@ through the `aws_s3_presigned_url` module.
#{<<"HasMoreStreams">> => false,<<"StreamNames">> => []}
```

### AWS RDS IAM Token Creation
Support for creating IAM Tokens (more info [here](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html)) has been added as part of the `aws_rds_iam_token` module.
This allows for easy creation of RDS/Aurora tokens to be used for IAM based authentication instead of username/password combination.
```erlang
> Client = aws_client:make_temporary_client(<<"AccessKeyID">>, <<"SecretAccessKey">>, <<"Token">>, <<"eu-west-1">>).
[...]
> {ok, Url} = create(Client, <<"db_endpoint">>, 5432, <<"db_user">>).
[...]
```

This token can subsequently be used to connect to the database over IAM.

### retry options

Each API which takes `Options` allows a `retry_options` key and can allow for automatic retries.
Expand Down

0 comments on commit 82b2198

Please sign in to comment.