Class EndpointProvider
Endpoint providers.
An endpoint provider is a function that accepts a hash of endpoint options, including but not limited to "service" and "region" key value pairs. The endpoint provider function returns a hash of endpoint data, which MUST include an "endpoint" key value pair that represents the resolved endpoint or NULL if an endpoint cannot be determined.
You can wrap your calls to an endpoint provider with the
EndpointProvider::resolve function to ensure that an endpoint hash is
created. If an endpoint hash is not created, then the resolve() function
will throw an Aws\Exception\UnresolvedEndpointException.
use Aws\Endpoint\EndpointProvider; $provider = EndpointProvider::defaultProvider(); // Returns an array or NULL. $endpoint = $provider(['service' => 'ec2', 'region' => 'us-west-2']); // Returns an endpoint array or throws. $endpoint = EndpointProvider::resolve($provider, [ 'service' => 'ec2', 'region' => 'us-west-2' ]);
You can compose multiple providers into a single provider using
Aws\or_chain(). This function accepts providers as arguments and
returns a new function that will invoke each provider until a non-null value
is returned.
$a = function (array $args) { if ($args['region'] === 'my-test-region') { return ['endpoint' => 'http://localhost:123/api']; } }; $b = EndpointProvider::defaultProvider(); $c = \Aws\or_chain($a, $b); $config = ['service' => 'ec2', 'region' => 'my-test-region']; $res = $c($config); // $a handles this. $config['region'] = 'us-west-2'; $res = $c($config); // $b handles this.
Methods Summary
-
static
resolve ( callable $provider, array $args = [] )
Resolves and endpoint provider and ensures a non-null return value.
-
static
defaultProvider ( )
Creates and returns the default SDK endpoint provider.
-
static
patterns ( array $patterns )
Creates and returns an endpoint provider that uses patterns from an array.
Methods Details
static array resolve ( callable $provider, array $args = [] )
Resolves and endpoint provider and ensures a non-null return value.
Parameters
| callable | $provider | Provider function to invoke. |
| array | $args = [] | Endpoint arguments to pass to the provider. |
Returns
| array |
Exceptions
Aws\Exception\UnresolvedEndpointException |
static callable defaultProvider ( )
Creates and returns the default SDK endpoint provider.
Deprecated
Returns
| callable |
static callable patterns ( array $patterns )
Creates and returns an endpoint provider that uses patterns from an array.
Parameters
| array | $patterns | Endpoint patterns |
Returns
| callable |