Class AbstractConfigurationProvider
A configuration provider is a function that returns a promise that is fulfilled with a configuration object. This class provides base functionality usable by specific configuration provider implementations
Direct known subclasses
Aws\ClientSideMonitoring\ConfigurationProvider
,
Aws\DefaultsMode\ConfigurationProvider
,
Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
,
Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
,
Aws\EndpointDiscovery\ConfigurationProvider
,
Aws\Retry\ConfigurationProvider
,
Aws\S3\RegionalEndpoint\ConfigurationProvider
,
Aws\S3\UseArnRegion\ConfigurationProvider
,
Aws\Sts\RegionalEndpoints\ConfigurationProvider
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 configuration provider that invokes the provided variadic providers one after the other until a provider returns configuration.
-
static
memoize ( callable $provider )
Wraps a config provider and caches previously provided configuration.
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 configuration |
string|null | $cacheKey = null | (optional) Cache key to use |
Returns
callable |
static callable chain ( )
Creates an aggregate configuration provider that invokes the provided variadic providers one after the other until a provider returns configuration.
Returns
callable |
static callable memoize ( callable $provider )
Wraps a config provider and caches previously provided configuration.
Parameters
callable | $provider | Config provider function to wrap. |
Returns
callable |
Constants summary
string |
ENV_PROFILE
|
#
'AWS_PROFILE'
|
string |
ENV_CONFIG_FILE
|
#
'AWS_CONFIG_FILE'
|