This class contains region information used to lazily compute the service endpoints. The static constants representing the regions can be used while constructing the AWS client instead of looking up the exact endpoint URL.
Inheritance Hierarchy
Namespace: Amazon
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public class RegionEndpoint
The RegionEndpoint type exposes the following members
Properties
| Name | Type | Description | |
|---|---|---|---|
|
DisplayName | System.String |
Gets the display name of a region. |
|
|
EnumerableAllRegions | System.Collections.Generic.IEnumerable<Amazon.RegionEndpoint> |
Enumerate through all the regions. |
|
|
OriginalSystemName | System.String | |
|
|
PartitionDnsSuffix | System.String |
Gets the dns suffix for the region endpoints in a partition. For example the aws partition's suffix is amazonaws.com. The aws-cn partition's suffix is amazonaws.com.cn. |
|
|
PartitionName | System.String |
Gets the partition name the region is in. For example for us-east-1 the partition name is aws. For cn-northwest-1 the partition name is aws-cn. |
|
|
SystemName | System.String |
Gets the system name of a region. |
Methods
| Name | Description | |
|---|---|---|
|
|
GetBySystemName(string) |
Gets the region based on its system name like "us-west-1" |
|
|
GetDnsSuffixForPartition(string) |
Returns the DNS suffix for the given partition, or an empty string if a matching partition was not found in endpoints.json |
|
|
GetEndpointForService(string) |
Gets the endpoint for a service in a region. |
|
|
GetEndpointForService(string, bool) |
Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint. |
|
|
GetEndpointForService(string, GetEndpointForServiceOptions) |
Gets the endpoint for a service in a region. For forwards compatibility, if the service being requested for isn't known in the region, this method will generate an endpoint using the AWS endpoint heuristics. In this case, it is not guaranteed the endpoint will point to a valid service endpoint. |
|
|
GetRegionEndpointOverride(RegionEndpoint) |
Gets the region endpoint override if exists |
|
|
Reload(Stream) |
Force the SDK to load and apply the given endpoints details (eg: an updated endpoints.json file). Service clients created after this call will be set up with endpoints based on this information. This function should only be used at application startup, before creating service clients. Known Caveats: * static readonly fields (eg: Amazon.RegionEndpoint.USEast1) are not updated. If you use this function, you should use Amazon.RegionEndpoint.GetEndpoint(System.String,System.String) with explicit region system names to ensure you work with RegionEndpoint objects containing the reloaded data. RegionEndpoint objects returned from GetEndpoint will generally fail Equality comparisons against the static fields. * Service clients created before calling Reload have no guarantee around which endpoint data will be used. |
Fields
| Name | Type | Description | |
|---|---|---|---|
|
|
AFSouth1 | Amazon.RegionEndpoint |
The Africa (Cape Town) endpoint. |
|
|
APEast1 | Amazon.RegionEndpoint |
The Asia Pacific (Hong Kong) endpoint. |
|
|
APNortheast1 | Amazon.RegionEndpoint |
The Asia Pacific (Tokyo) endpoint. |
|
|
APNortheast2 | Amazon.RegionEndpoint |
The Asia Pacific (Seoul) endpoint. |
|
|
APNortheast3 | Amazon.RegionEndpoint |
The Asia Pacific (Osaka) endpoint. |
|
|
APSouth1 | Amazon.RegionEndpoint |
The Asia Pacific (Mumbai) endpoint. |
|
|
APSouth2 | Amazon.RegionEndpoint |
The Asia Pacific (Hyderabad) endpoint. |
|
|
APSoutheast1 | Amazon.RegionEndpoint |
The Asia Pacific (Singapore) endpoint. |
|
|
APSoutheast2 | Amazon.RegionEndpoint |
The Asia Pacific (Sydney) endpoint. |
|
|
APSoutheast3 | Amazon.RegionEndpoint |
The Asia Pacific (Jakarta) endpoint. |
|
|
APSoutheast4 | Amazon.RegionEndpoint |
The Asia Pacific (Melbourne) endpoint. |
|
|
APSoutheast5 | Amazon.RegionEndpoint |
The Asia Pacific (Malaysia) endpoint. |
|
|
CACentral1 | Amazon.RegionEndpoint |
The Canada (Central) endpoint. |
|
|
CAWest1 | Amazon.RegionEndpoint |
The Canada West (Calgary) endpoint. |
|
|
CNNorth1 | Amazon.RegionEndpoint |
The China (Beijing) endpoint. |
|
|
CNNorthWest1 | Amazon.RegionEndpoint |
The China (Ningxia) endpoint. |
|
|
EUCentral1 | Amazon.RegionEndpoint |
The Europe (Frankfurt) endpoint. |
|
|
EUCentral2 | Amazon.RegionEndpoint |
The Europe (Zurich) endpoint. |
|
|
EUIsoeWest1 | Amazon.RegionEndpoint |
The EU ISOE West endpoint. |
|
|
EUNorth1 | Amazon.RegionEndpoint |
The Europe (Stockholm) endpoint. |
|
|
EUSouth1 | Amazon.RegionEndpoint |
The Europe (Milan) endpoint. |
|
|
EUSouth2 | Amazon.RegionEndpoint |
The Europe (Spain) endpoint. |
|
|
EUWest1 | Amazon.RegionEndpoint |
The Europe (Ireland) endpoint. |
|
|
EUWest2 | Amazon.RegionEndpoint |
The Europe (London) endpoint. |
|
|
EUWest3 | Amazon.RegionEndpoint |
The Europe (Paris) endpoint. |
|
|
ILCentral1 | Amazon.RegionEndpoint |
The Israel (Tel Aviv) endpoint. |
|
|
MECentral1 | Amazon.RegionEndpoint |
The Middle East (UAE) endpoint. |
|
|
MESouth1 | Amazon.RegionEndpoint |
The Middle East (Bahrain) endpoint. |
|
|
SAEast1 | Amazon.RegionEndpoint |
The South America (Sao Paulo) endpoint. |
|
|
USEast1 | Amazon.RegionEndpoint |
The US East (N. Virginia) endpoint. |
|
|
USEast2 | Amazon.RegionEndpoint |
The US East (Ohio) endpoint. |
|
|
USGovCloudEast1 | Amazon.RegionEndpoint |
The AWS GovCloud (US-East) endpoint. |
|
|
USGovCloudWest1 | Amazon.RegionEndpoint |
The AWS GovCloud (US-West) endpoint. |
|
|
USIsobEast1 | Amazon.RegionEndpoint |
The US ISOB East (Ohio) endpoint. |
|
|
USIsoEast1 | Amazon.RegionEndpoint |
The US ISO East endpoint. |
|
|
USIsoWest1 | Amazon.RegionEndpoint |
The US ISO WEST endpoint. |
|
|
USWest1 | Amazon.RegionEndpoint |
The US West (N. California) endpoint. |
|
|
USWest2 | Amazon.RegionEndpoint |
The US West (Oregon) endpoint. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5