Class PartitionEndpointProvider
Methods Summary
-
__construct ( array $partitions, string $defaultPartition = 'aws', array $options = [] )
The 'options' parameter accepts the following arguments:
- __invoke ( array $args = [] )
-
getPartition ( string $region, string $service )
Returns the partition containing the provided region or the default partition if no match is found.
-
getPartitionByName ( string $name )
Returns the partition with the provided name or null if no partition with the provided name can be found.
-
static
defaultProvider ( array $options = [] )
Creates and returns the default SDK partition provider.
-
static
mergePrefixData ( $data, $prefixData )
Copy endpoint data for other prefixes used by a given service
Methods Details
__construct ( array $partitions, string $defaultPartition = 'aws', array $options = [] )
The 'options' parameter accepts the following arguments:
- sts_regional_endpoints: For STS legacy regions, set to 'regional' to use regional endpoints, 'legacy' to use the legacy global endpoint. Defaults to 'legacy'.
- s3_us_east_1_regional_endpoint: For S3 us-east-1 region, set to 'regional' to use the regional endpoint, 'legacy' to use the legacy global endpoint. Defaults to 'legacy'.
Parameters
| array | $partitions | |
| string | $defaultPartition = 'aws' | |
| array | $options = [] |
__invoke ( array $args = [] )
Aws\Endpoint\Partition
getPartition (
string
$region,
string
$service
)
Returns the partition containing the provided region or the default partition if no match is found.
Parameters
| string | $region | |
| string | $service |
Returns
Aws\Endpoint\Partition |
Aws\Endpoint\Partition|null
getPartitionByName (
string
$name
)
Returns the partition with the provided name or null if no partition with the provided name can be found.
Parameters
| string | $name |
Returns
Aws\Endpoint\Partition|null |
static
Aws\Endpoint\PartitionEndpointProvider
defaultProvider (
array
$options = []
)
Creates and returns the default SDK partition provider.
Parameters
| array | $options = [] |
Returns
Aws\Endpoint\PartitionEndpointProvider |
static array mergePrefixData ( $data, $prefixData )
Copy endpoint data for other prefixes used by a given service
Parameters
| $data | ||
| $prefixData |
Returns
| array |