doc.go raw

   1  // Package config provides utilities for loading configuration from multiple
   2  // sources that can be used to configure the SDK's API clients, and utilities.
   3  //
   4  // The config package will load configuration from environment variables, AWS
   5  // shared configuration file (~/.aws/config), and AWS shared credentials file
   6  // (~/.aws/credentials).
   7  //
   8  // Use the LoadDefaultConfig to load configuration from all the SDK's supported
   9  // sources, and resolve credentials using the SDK's default credential chain.
  10  //
  11  // LoadDefaultConfig allows for a variadic list of additional Config sources that can
  12  // provide one or more configuration values which can be used to programmatically control the resolution
  13  // of a specific value, or allow for broader range of additional configuration sources not supported by the SDK.
  14  // A Config source implements one or more provider interfaces defined in this package. Config sources passed in will
  15  // take precedence over the default environment and shared config sources used by the SDK. If one or more Config sources
  16  // implement the same provider interface, priority will be handled by the order in which the sources were passed in.
  17  //
  18  // A number of helpers (prefixed by “With“)  are provided in this package that implement their respective provider
  19  // interface. These helpers should be used for overriding configuration programmatically at runtime.
  20  package config
  21