Class ConfigurationProvider
A configuration provider is a function that returns a promise that is
fulfilled with a Aws\EndpointDiscovery\ConfigurationInterface
or rejected with an Aws\EndpointDiscovery\Exception\ConfigurationException.
use Aws\EndpointDiscovery\ConfigurationProvider; $provider = ConfigurationProvider::defaultProvider(); // Returns a ConfigurationInterface or throws. $config = $provider()->wait();
Configuration providers can be composed to create configuration using conditional logic that can create different configurations in different environments. You can compose multiple providers into a single provider using Aws\EndpointDiscovery\ConfigurationProvider::chain. This function accepts providers as variadic arguments and returns a new function that will invoke each provider until a successful configuration is returned.
// First try an INI file at this location. $a = ConfigurationProvider::ini(null, '/path/to/file.ini'); // Then try an INI file at this location. $b = ConfigurationProvider::ini(null, '/path/to/other-file.ini'); // Then try loading from environment variables. $c = ConfigurationProvider::env(); // Combine the three providers together. $composed = ConfigurationProvider::chain($a, $b, $c); // Returns a promise that is fulfilled with a configuration or throws. $promise = $composed(); // Wait on the configuration to resolve. $config = $promise->wait();
Methods Summary
-
static
cache ( callable $provider, Aws\CacheInterface $cache, string|null $cacheKey = null )
Wraps a config provider and saves provided configuration in an instance of Aws\CacheInterface. Forwards calls when no config found in cache and updates cache with the results.
-
static
chain ( )
Creates an aggregate credentials provider that invokes the provided variadic providers one after the other until a provider returns credentials.
-
static
defaultProvider ( array $config = [] )
Create a default config provider that first checks for environment variables, then checks for a specified profile in ~/.aws/config, then checks for the "default" profile in ~/.aws/config, and failing those uses a default fallback set of configuration options.
-
static
env ( $cacheLimit = self::DEFAULT_CACHE_LIMIT )
Provider that creates config from environment variables.
-
static
fallback ( )
Fallback config options when other sources are not set.
-
static
ini ( string|null $profile = null, string|null $filename = null, int $cacheLimit = self::DEFAULT_CACHE_LIMIT )
Config provider that creates config using an ini file stored in the current user's home directory.
-
static
memoize ( callable $provider )
Wraps a config provider and caches previously provided configuration.
-
static
unwrap ( mixed $config )
Unwraps a configuration object in whatever valid form it is in, always returning a ConfigurationInterface object.
Methods Details
static
callable
cache (
callable
$provider,
Aws\CacheInterface
$cache,
string|null
$cacheKey = null
)
Wraps a config provider and saves provided configuration in an instance of Aws\CacheInterface. Forwards calls when no config found in cache and updates cache with the results.
Parameters
| callable | $provider | Configuration provider function to wrap |
Aws\CacheInterface |
$cache | Cache to store credentials |
| string|null | $cacheKey = null | (optional) Cache key to use |
Returns
| callable |
static callable chain ( )
Creates an aggregate credentials provider that invokes the provided variadic providers one after the other until a provider returns credentials.
Returns
| callable |
static callable defaultProvider ( array $config = [] )
Create a default config provider that first checks for environment variables, then checks for a specified profile in ~/.aws/config, then checks for the "default" profile in ~/.aws/config, and failing those uses a default fallback set of configuration options.
This provider is automatically wrapped in a memoize function that caches previously provided config options.
Parameters
| array | $config = [] | Optional array of ecs/instance profile credentials provider options. |
Returns
| callable |
static callable env ( $cacheLimit = self::DEFAULT_CACHE_LIMIT )
Provider that creates config from environment variables.
Parameters
| $cacheLimit = self::DEFAULT_CACHE_LIMIT |
Returns
| callable |
static callable fallback ( )
Fallback config options when other sources are not set.
Returns
| callable |
static callable ini ( string|null $profile = null, string|null $filename = null, integer $cacheLimit = self::DEFAULT_CACHE_LIMIT )
Config provider that creates config using an ini file stored in the current user's home directory.
Parameters
| string|null | $profile = null | Profile to use. If not specified will use the "default" profile in "~/.aws/config". |
| string|null | $filename = null | If provided, uses a custom filename rather than looking in the home directory. |
| integer | $cacheLimit = self::DEFAULT_CACHE_LIMIT |
Returns
| callable |
static callable memoize ( callable $provider )
Wraps a config provider and caches previously provided configuration.
Ensures that cached configuration is refreshed when it expires.
Parameters
| callable | $provider | Config provider function to wrap. |
Returns
| callable |
static
Aws\EndpointDiscovery\ConfigurationInterface
unwrap (
mixed
$config
)
Unwraps a configuration object in whatever valid form it is in, always returning a ConfigurationInterface object.
Parameters
| mixed | $config |
Returns
Aws\EndpointDiscovery\ConfigurationInterface |
Exceptions
| InvalidArgumentException |
Constants summary
string |
CACHE_KEY
|
#
'aws_cached_endpoint_discovery_config'
|
boolean |
DEFAULT_ENABLED
|
#
false
|
integer |
DEFAULT_CACHE_LIMIT
|
#
1000
|
string |
ENV_ENABLED
|
#
'AWS_ENDPOINT_DISCOVERY_ENABLED'
|
string |
ENV_ENABLED_ALT
|
#
'AWS_ENABLE_ENDPOINT_DISCOVERY'
|
string |
ENV_PROFILE
|
#
'AWS_PROFILE'
|
