Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.RegionEndpoint Class Reference

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

Classes

class  Endpoint
 This class defines an endpoints hostname and which protocols it supports. More...
 

Public Member Functions

Endpoint GetEndpointForService (string serviceName)
 Gets the endpoint for a service in a region. More...
 
Endpoint GuessEndpointForService (string serviceName)
 
override string ToString ()
 

Static Public Member Functions

static RegionEndpoint GetBySystemName (string systemName)
 Gets the region based on its system name like "us-west-1" More...
 
static void LoadEndpointDefinitions (StreamReader reader)
 Parse the endpoint definition. This method is only meant to be called directly for testing purposes. More...
 
static void LoadRegion (XmlReader xmlReader, ref RegionEndpoint currentRegion)
 
static void LoadEndpoint (XmlReader xmlReader, RegionEndpoint currentRegion)
 
static void UnloadEndpointDefinitions ()
 This is a testing method and should not be called by production applications. More...
 

Static Public Attributes

static readonly RegionEndpoint USEast1 = NewEndpoint("us-east-1", "US East (Virginia)")
 The US East (Virginia) endpoint. More...
 
static readonly RegionEndpoint USWest1 = NewEndpoint("us-west-1", "US West (N. California)")
 The US West (N. California) endpoint. More...
 
static readonly RegionEndpoint USWest2 = NewEndpoint("us-west-2", "US West (Oregon)")
 The US West (Oregon) endpoint. More...
 
static readonly RegionEndpoint EUWest1 = NewEndpoint("eu-west-1", "EU West (Ireland)")
 The EU West (Ireland) endpoint. More...
 
static readonly RegionEndpoint APNortheast1 = NewEndpoint("ap-northeast-1", "Asia Pacific (Tokyo)")
 The Asia Pacific (Tokyo) endpoint. More...
 
static readonly RegionEndpoint APSoutheast1 = NewEndpoint("ap-southeast-1", "Asia Pacific (Singapore)")
 The Asia Pacific (Singapore) endpoint. More...
 
static readonly RegionEndpoint APSoutheast2 = NewEndpoint("ap-southeast-2", "Asia Pacific (Sydney)")
 The Asia Pacific (Sydney) endpoint. More...
 
static readonly RegionEndpoint SAEast1 = NewEndpoint("sa-east-1", "South America (Sao Paulo)")
 The South America (Sao Paulo) endpoint. More...
 
static readonly RegionEndpoint USGovCloudWest1 = NewEndpoint("us-gov-west-1", "US GovCloud West (Oregon)")
 The US GovCloud West (Oregon) endpoint. More...
 
static readonly RegionEndpoint CNNorth1 = NewEndpoint("cn-north-1", "China (Beijing)", "amazonaws.com.cn")
 The China (Beijing) endpoint. More...
 

Properties

static IEnumerable
< RegionEndpoint
EnumerableAllRegions [get]
 Enumerate through all the regions. More...
 
string SystemName [get, set]
 Gets the system name of a region. More...
 
string DisplayName [get, set]
 Gets the display name of a region. More...
 

Detailed Description

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.

Member Function Documentation

static RegionEndpoint Amazon.RegionEndpoint.GetBySystemName ( string  systemName)
static

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

Parameters
systemNameThe system name of the service like "us-west-1"
Returns
Endpoint Amazon.RegionEndpoint.GetEndpointForService ( string  serviceName)

Gets the endpoint for a service in a region.

Parameters
serviceNameThe services system name.
Exceptions
System.ArgumentExceptionThrown when the request service does not have a valid endpoint in the region.
Returns
static void Amazon.RegionEndpoint.LoadEndpointDefinitions ( StreamReader  reader)
static

Parse the endpoint definition. This method is only meant to be called directly for testing purposes.

Parameters
readerA reader of the endpoint definitions
static void Amazon.RegionEndpoint.UnloadEndpointDefinitions ( )
static

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

Member Data Documentation

readonly RegionEndpoint Amazon.RegionEndpoint.APNortheast1 = NewEndpoint("ap-northeast-1", "Asia Pacific (Tokyo)")
static

The Asia Pacific (Tokyo) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.APSoutheast1 = NewEndpoint("ap-southeast-1", "Asia Pacific (Singapore)")
static

The Asia Pacific (Singapore) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.APSoutheast2 = NewEndpoint("ap-southeast-2", "Asia Pacific (Sydney)")
static

The Asia Pacific (Sydney) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.CNNorth1 = NewEndpoint("cn-north-1", "China (Beijing)", "amazonaws.com.cn")
static

The China (Beijing) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.EUWest1 = NewEndpoint("eu-west-1", "EU West (Ireland)")
static

The EU West (Ireland) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.SAEast1 = NewEndpoint("sa-east-1", "South America (Sao Paulo)")
static

The South America (Sao Paulo) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.USEast1 = NewEndpoint("us-east-1", "US East (Virginia)")
static

The US East (Virginia) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.USGovCloudWest1 = NewEndpoint("us-gov-west-1", "US GovCloud West (Oregon)")
static

The US GovCloud West (Oregon) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.USWest1 = NewEndpoint("us-west-1", "US West (N. California)")
static

The US West (N. California) endpoint.

readonly RegionEndpoint Amazon.RegionEndpoint.USWest2 = NewEndpoint("us-west-2", "US West (Oregon)")
static

The US West (Oregon) endpoint.

Property Documentation

string Amazon.RegionEndpoint.DisplayName
getset

Gets the display name of a region.

IEnumerable<RegionEndpoint> Amazon.RegionEndpoint.EnumerableAllRegions
staticget

Enumerate through all the regions.

string Amazon.RegionEndpoint.SystemName
getset

Gets the system name of a region.


The documentation for this class was generated from the following file: