Table of Contents

Class RegionEndpointProviderV2.RegionEndpoint

Namespace
Amazon.Internal
Assembly
AWSSDK.Core.dll

This class contains the endpoints available to the AWS clients. The static constants representing the regions can be used while constructing the AWS client instead of looking up the exact endpoint URL.

public class RegionEndpointProviderV2.RegionEndpoint : IRegionEndpoint
Inheritance
RegionEndpointProviderV2.RegionEndpoint
Implements
Inherited Members

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<RegionEndpointProviderV2.RegionEndpoint> EnumerableAllRegions { get; }

Property Value

IEnumerable<RegionEndpointProviderV2.RegionEndpoint>

RegionName 

public string RegionName { 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 RegionEndpointProviderV2.RegionEndpoint GetBySystemName(string systemName)

Parameters

systemName string

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

Returns

RegionEndpointProviderV2.RegionEndpoint

GetEndpointForService(string, GetEndpointForServiceOptions)

Gets the endpoint for a service in a region.

public RegionEndpoint.Endpoint GetEndpointForService(string serviceName, GetEndpointForServiceOptions options)

Parameters

serviceName string

The services system name.

options GetEndpointForServiceOptions

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

Returns

RegionEndpoint.Endpoint

Exceptions

ArgumentException

Thrown when the request service does not have a valid endpoint in the region.

GetEndpointForService(string, bool)

Gets the endpoint for a service in a region.

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

Parameters

serviceName string

The services system name.

dualStack bool

If true returns the endpoint for dualstack

Returns

RegionEndpoint.Endpoint

Exceptions

ArgumentException

Thrown when the request service does not have a valid endpoint in the region.

LoadEndpointDefinitions(string) 

public static void LoadEndpointDefinitions(string endpointsPath)

Parameters

endpointsPath string

ToString() 

public override string ToString()

Returns

string

UnloadEndpointDefinitions()

This is a testing method and should not be called by production applications.

public static void UnloadEndpointDefinitions()