credentials

Documentation

Index

• Constants
• Variables
• func FromEnv() iam.Credentials
• func FromFile() iam.Credentials
• func Get() iam.Credentials
• func ToFile(c iam.Credentials) error

Constants

const ConfigFileSource = "Configuration file"

ConfigFileSource indicates the credentials are retrieved from configuration file.

const EnvSource = "Environment variables"

EnvSource indicates the credentials are retrieved from environment variables.

Variables

var DefaultCredsPath = ""

DefaultCredsPath returns the default location of the credentials file. It's under the user's home directory, if defined, otherwise under the current working directory.

Functions

func FromEnv

func FromEnv() iam.Credentials

FromEnv reads the credentials from the user environment.

func FromFile

func FromFile() iam.Credentials

FromFile reads the credentials that stored in the default file location.

func Get

func Get() iam.Credentials

Get returns the configured credentials. Effectively a convenience wrapper around FromEnv, followed by a call to FromFile.

The lookup order is:

1. Environment variables (see FromEnv)
2. Credentials file (see FromFile)

func ToFile

func ToFile(c iam.Credentials) error

ToFile stores the provided credentials in the default file location.