File: doc.go

package info (click to toggle)
golang-github-aws-aws-sdk-go 1.16.18%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, buster-backports, experimental
  • size: 93,084 kB
  • sloc: ruby: 193; makefile: 174; xml: 11
file content (18 lines) | stat: -rw-r--r-- 918 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 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