defaults

Documentation

Overview

Package defaults is a collection of helpers to retrieve the SDK's default configuration and handlers.

Generally this package shouldn't be used directly, but session.Session instead. This package is useful when you need to reset the defaults of a session or service client to the SDK defaults before setting additional parameters.

Index

• func Config() *volcstack.Config
• func CredChain(cfg *volcstack.Config, handlers request.Handlers) *credentials.Credentials
• func CredProviders(cfg *volcstack.Config, handlers request.Handlers) []credentials.Provider
• func Handlers() request.Handlers
• func SharedConfigFilename() string
• func SharedCredentialsFilename() string
• type Defaults
  • func Get() Defaults

Functions

func Config

func Config() *volcstack.Config

Config returns the default configuration without credentials. To retrieve a config with credentials also included use `defaults.Get().Config` instead.

Generally you shouldn't need to use this method directly, but is available if you need to reset the configuration of an existing service client or session.

func CredChain

func CredChain(cfg *volcstack.Config, handlers request.Handlers) *credentials.Credentials

CredChain returns the default credential chain.

Generally you shouldn't need to use this method directly, but is available if you need to reset the credentials of an existing service client or session's Config.

func CredProviders

func CredProviders(cfg *volcstack.Config, handlers request.Handlers) []credentials.Provider

CredProviders returns the slice of providers used in the default credential chain.

For applications that need to use some other provider (for example use different environment variables for legacy reasons) but still fall back on the default chain of providers. This allows that default chaint to be automatically updated

func Handlers

func Handlers() request.Handlers

Handlers returns the default request handlers.

Generally you shouldn't need to use this method directly, but is available if you need to reset the request handlers of an existing service client or session.

func SharedConfigFilename

func SharedConfigFilename() string

SharedConfigFilename returns the SDK's default file path for the shared config file.

Builds the shared config file path based on the OS's platform.

• Linux/Unix: $HOME/.aws/config
• Windows: %USERPROFILE%\.aws\config

func SharedCredentialsFilename

func SharedCredentialsFilename() string

SharedCredentialsFilename returns the SDK's default file path for the shared credentials file.

Builds the shared config file path based on the OS's platform.

• Linux/Unix: $HOME/.aws/credentials
• Windows: %USERPROFILE%\.aws\credentials

Types

type Defaults

type Defaults struct {
	Config   *volcstack.Config
	Handlers request.Handlers
}

A Defaults provides a collection of default values for SDK clients.

func Get

func Get() Defaults

Get returns the SDK's default values with Config and handlers pre-configured.