SDK for PHP 3.x

PartitionEndpointProvider
in package

Table of Contents

Methods

__construct()  : mixed
The 'options' parameter accepts the following arguments:
__invoke()  : mixed
defaultProvider()  : PartitionEndpointProvider
Creates and returns the default SDK partition provider.
getPartition()  : Partition
Returns the partition containing the provided region or the default partition if no match is found.
getPartitionByName()  : Partition|null
Returns the partition with the provided name or null if no partition with the provided name can be found.
mergePrefixData()  : array<string|int, mixed>
Copy endpoint data for other prefixes used by a given service

Methods

__construct()

The 'options' parameter accepts the following arguments:

public __construct(array<string|int, mixed> $partitions[, string $defaultPartition = 'aws' ][, array<string|int, mixed> $options = [] ]) : mixed
  • 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
$partitions : array<string|int, mixed>
$defaultPartition : string = 'aws'
$options : array<string|int, mixed> = []

__invoke()

public __invoke([array<string|int, mixed> $args = [] ]) : mixed
Parameters
$args : array<string|int, mixed> = []

defaultProvider()

Creates and returns the default SDK partition provider.

public static defaultProvider([array<string|int, mixed> $options = [] ]) : PartitionEndpointProvider
Parameters
$options : array<string|int, mixed> = []
Return values
PartitionEndpointProvider

getPartition()

Returns the partition containing the provided region or the default partition if no match is found.

public getPartition(string $region, string $service) : Partition
Parameters
$region : string
$service : string
Return values
Partition

getPartitionByName()

Returns the partition with the provided name or null if no partition with the provided name can be found.

public getPartitionByName(string $name) : Partition|null
Parameters
$name : string
Return values
Partition|null

mergePrefixData()

Copy endpoint data for other prefixes used by a given service

public static mergePrefixData( $data,  $prefixData) : array<string|int, mixed>
Parameters
$data :
$prefixData :
Return values
array<string|int, mixed>
On this page