auth

Documentation

Overview

Package auth is used to generate authentication tokens for Amazon Aurora DSQL.

These tokens use IAM policies to generate a token that will be used to connect to a database.

You can see more details about it at the official docs

Index

• func GenerateDBConnectAdminAuthToken(ctx context.Context, endpoint, region string, creds aws.CredentialsProvider, ...) (string, error)
• func GenerateDbConnectAuthToken(ctx context.Context, endpoint, region string, creds aws.CredentialsProvider, ...) (string, error)
• type TokenOptions

Functions

func GenerateDBConnectAdminAuthToken

func GenerateDBConnectAdminAuthToken(ctx context.Context, endpoint, region string, creds aws.CredentialsProvider, optFns ...func(options *TokenOptions)) (string, error)

GenerateDBConnectAdminAuthToken Generates an admin authentication token for IAM authentication to a DSQL database.

This is the admin user variant, see GenerateDbConnectAuthToken for the regular user variant

* endpoint - Endpoint is the hostname to connect to the database * region - Region is where the database is located * creds - Credentials to use when signing the token

func GenerateDbConnectAuthToken

func GenerateDbConnectAuthToken(ctx context.Context, endpoint, region string, creds aws.CredentialsProvider, optFns ...func(options *TokenOptions)) (string, error)

GenerateDbConnectAuthToken generates an authentication token for IAM authentication to a DSQL database

This is the regular user variant, see GenerateDBConnectAdminAuthToken for the admin variant

* endpoint - Endpoint is the hostname to connect to the database * region - Region is where the database is located * creds - Credentials to use when signing the token

Types

type TokenOptions

type TokenOptions struct {
	ExpiresIn time.Duration
}

TokenOptions is the optional set of configuration properties for AuthToken