-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
doc.go
20 lines (20 loc) · 952 Bytes
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Package rdsutils is used to generate authentication tokens used to
// connect to a givent Amazon Relational Database Service (RDS) database.
//
// Before using the authentication please visit the docs here to ensure
// the database has the proper policies to allow for IAM token authentication.
// https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html#UsingWithRDS.IAMDBAuth.Availability
//
// When building the connection string, there are two required parameters that are needed to be set on the query.
//
// - tls
//
// - allowCleartextPasswords must be set to true
//
// Example creating a basic auth token with the builder:
// v := url.Values{}
// v.Add("tls", "tls_profile_name")
// v.Add("allowCleartextPasswords", "true")
// b := rdsutils.NewConnectionStringBuilder(endpoint, region, user, dbname, creds)
// connectStr, err := b.WithTCPFormat().WithParams(v).Build()
package rdsutils