Class RegionEndpoint

Namespace

Amazon

Assembly

AWSSDK.Core.dll

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.

public class RegionEndpoint

Inheritance

object

RegionEndpoint

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

GetEndpointForServiceOptionsExtensions.GetEndpointForService(RegionEndpoint, IClientConfig)

Fields

AFSouth1

The Africa (Cape Town) endpoint.

public static readonly RegionEndpoint AFSouth1

Field Value

RegionEndpoint

APEast1

The Asia Pacific (Hong Kong) endpoint.

public static readonly RegionEndpoint APEast1

Field Value

RegionEndpoint

APNortheast1

The Asia Pacific (Tokyo) endpoint.

public static readonly RegionEndpoint APNortheast1

Field Value

RegionEndpoint

APNortheast2

The Asia Pacific (Seoul) endpoint.

public static readonly RegionEndpoint APNortheast2

Field Value

RegionEndpoint

APNortheast3

The Asia Pacific (Osaka) endpoint.

public static readonly RegionEndpoint APNortheast3

Field Value

RegionEndpoint

APSouth1

The Asia Pacific (Mumbai) endpoint.

public static readonly RegionEndpoint APSouth1

Field Value

RegionEndpoint

APSouth2

The Asia Pacific (Hyderabad) endpoint.

public static readonly RegionEndpoint APSouth2

Field Value

RegionEndpoint

APSoutheast1

The Asia Pacific (Singapore) endpoint.

public static readonly RegionEndpoint APSoutheast1

Field Value

RegionEndpoint

APSoutheast2

The Asia Pacific (Sydney) endpoint.

public static readonly RegionEndpoint APSoutheast2

Field Value

RegionEndpoint

APSoutheast3

The Asia Pacific (Jakarta) endpoint.

public static readonly RegionEndpoint APSoutheast3

Field Value

RegionEndpoint

APSoutheast4

The Asia Pacific (Melbourne) endpoint.

public static readonly RegionEndpoint APSoutheast4

Field Value

RegionEndpoint

CACentral1

The Canada (Central) endpoint.

public static readonly RegionEndpoint CACentral1

Field Value

RegionEndpoint

CNNorth1

The China (Beijing) endpoint.

public static readonly RegionEndpoint CNNorth1

Field Value

RegionEndpoint

CNNorthWest1

The China (Ningxia) endpoint.

public static readonly RegionEndpoint CNNorthWest1

Field Value

RegionEndpoint

EUCentral1

The Europe (Frankfurt) endpoint.

public static readonly RegionEndpoint EUCentral1

Field Value

RegionEndpoint

EUCentral2

The Europe (Zurich) endpoint.

public static readonly RegionEndpoint EUCentral2

Field Value

RegionEndpoint

EUNorth1

The Europe (Stockholm) endpoint.

public static readonly RegionEndpoint EUNorth1

Field Value

RegionEndpoint

EUSouth1

The Europe (Milan) endpoint.

public static readonly RegionEndpoint EUSouth1

Field Value

RegionEndpoint

EUSouth2

The Europe (Spain) endpoint.

public static readonly RegionEndpoint EUSouth2

Field Value

RegionEndpoint

EUWest1

The Europe (Ireland) endpoint.

public static readonly RegionEndpoint EUWest1

Field Value

RegionEndpoint

EUWest2

The Europe (London) endpoint.

public static readonly RegionEndpoint EUWest2

Field Value

RegionEndpoint

EUWest3

The Europe (Paris) endpoint.

public static readonly RegionEndpoint EUWest3

Field Value

RegionEndpoint

MECentral1

The Middle East (UAE) endpoint.

public static readonly RegionEndpoint MECentral1

Field Value

RegionEndpoint

MESouth1

The Middle East (Bahrain) endpoint.

public static readonly RegionEndpoint MESouth1

Field Value

RegionEndpoint

SAEast1

The South America (Sao Paulo) endpoint.

public static readonly RegionEndpoint SAEast1

Field Value

RegionEndpoint

USEast1

The US East (N. Virginia) endpoint.

public static readonly RegionEndpoint USEast1

Field Value

RegionEndpoint

USEast2

The US East (Ohio) endpoint.

public static readonly RegionEndpoint USEast2

Field Value

RegionEndpoint

USGovCloudEast1

The AWS GovCloud (US-East) endpoint.

public static readonly RegionEndpoint USGovCloudEast1

Field Value

RegionEndpoint

USGovCloudWest1

The AWS GovCloud (US-West) endpoint.

public static readonly RegionEndpoint USGovCloudWest1

Field Value

RegionEndpoint

USIsoEast1

The US ISO East endpoint.

public static readonly RegionEndpoint USIsoEast1

Field Value

RegionEndpoint

USIsoWest1

The US ISO WEST endpoint.

public static readonly RegionEndpoint USIsoWest1

Field Value

RegionEndpoint

USIsobEast1

The US ISOB East (Ohio) endpoint.

public static readonly RegionEndpoint USIsobEast1

Field Value

RegionEndpoint

USWest1

The US West (N. California) endpoint.

public static readonly RegionEndpoint USWest1

Field Value

RegionEndpoint

USWest2

The US West (Oregon) endpoint.

public static readonly RegionEndpoint USWest2

Field Value

RegionEndpoint

Properties

DisplayName

Gets the display name of a region.

public string DisplayName { get; }

Property Value

string

EnumerableAllRegions

Enumerate through all the regions.

public static IEnumerable<RegionEndpoint> EnumerableAllRegions { get; }

Property Value

IEnumerable<RegionEndpoint>

OriginalSystemName

[Obsolete("It should not be necessary to use this property.  To support upgrading to Endpoint Variants, ClientConfig will manipulate the assigned RegionEndpoint.  To support the Polly PreSigner, it's still necessaryto check the OriginalSystemName to determine if a PseudoRegion was assigned.", false)]
public string OriginalSystemName { get; }

Property Value

string

PartitionDnsSuffix

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.

public string PartitionDnsSuffix { get; }

Property Value

string

PartitionName

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.

public string PartitionName { get; }

Property Value

string

SystemName

Gets the system name of a region.

public string SystemName { get; }

Property Value

string

Methods

GetBySystemName(string)

Gets the region based on its system name like "us-west-1"

public static RegionEndpoint GetBySystemName(string systemName)

Parameters

systemName string

The system name of the service like "us-west-1"

Returns

RegionEndpoint

GetDnsSuffixForPartition(string)

Returns the DNS suffix for the given partition, or an empty string if a matching partition was not found in endpoints.json

[Obsolete("This operation is obsoleted because as of version 3.7.100 endpoint is resolved using a newer system that uses request level parameters to resolve the endpoint.")]
public static string GetDnsSuffixForPartition(string partition)

Parameters

partition string

partition

Returns

string

DNS suffix for the given partition, empty string if a matching partition was not found

GetEndpointForService(string)

Gets the endpoint for a service in a region.

[Obsolete("This operation is obsoleted because as of version 3.7.100 endpoint is resolved using a newer system that uses request level parameters to resolve the endpoint.")]
public RegionEndpoint.Endpoint GetEndpointForService(string serviceName)

Parameters

serviceName string

The services system name. Service system names can be obtained from the RegionEndpointServiceName member of the ClientConfig-derived class for the service.

Returns

RegionEndpoint.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.

[Obsolete("This operation is obsoleted because as of version 3.7.100 endpoint is resolved using a newer system that uses request level parameters to resolve the endpoint.")]
public RegionEndpoint.Endpoint GetEndpointForService(string serviceName, GetEndpointForServiceOptions options)

Parameters

serviceName string

The services system name. Service system names can be obtained from the RegionEndpointServiceName member of the ClientConfig-derived class for the service.

options GetEndpointForServiceOptions

Specify additional requirements on the RegionEndpoint.Endpoint to be returned.

Returns

RegionEndpoint.Endpoint

GetEndpointForService(string, bool)

Gets the endpoint for a service in a region, optionally selecting a dualstack compatible endpoint.

[Obsolete("Use GetEndpointForService(string serviceName, GetEndpointForServiceOptions options) instead", false)]
public RegionEndpoint.Endpoint GetEndpointForService(string serviceName, bool dualStack)

Parameters

serviceName string

The services system name. Service system names can be obtained from the RegionEndpointServiceName member of the ClientConfig-derived class for the service.

dualStack bool

If true a dualstack endpoint is returned. It is the user's responsibility to verify that the given service supports a dualstack endpoint for the region.

Returns

RegionEndpoint.Endpoint

GetRegionEndpointOverride(RegionEndpoint)

Gets the region endpoint override if exists

[Obsolete("This operation is obsoleted because as of version 3.7.100 endpoint is resolved using a newer system that uses request level parameters to resolve the endpoint.")]
public static RegionEndpoint GetRegionEndpointOverride(RegionEndpoint regionEndpoint)

Parameters

regionEndpoint RegionEndpoint

The region endpoint to find the possible override for

Returns

RegionEndpoint

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: 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.

[Obsolete("This operation is obsoleted because as of version 3.7.100 endpoint is resolved using a newer system that uses request level parameters to resolve the endpoint.")]
public static void Reload(Stream stream)

Parameters

stream Stream

Stream containing an Endpoints manifest to reload in the SDK. Pass null in to reset the SDK, so that it uses its built-in manifest instead.

ToString()

public override string ToString()

Returns

string