com.amazonaws.regions

Enum Regions

java.lang.Object

java.lang.Enum<Regions>

com.amazonaws.regions.Regions

All Implemented Interfaces:

Serializable, Comparable<Regions>

public enum Regions
extends Enum<Regions>

Enumeration of region names

Enum Constant Summary

Enum Constants

Enum Constant and Description
AP_NORTHEAST_1
AP_SOUTHEAST_1
AP_SOUTHEAST_2
CN_NORTH_1
EU_CENTRAL_1
EU_WEST_1
GovCloud
SA_EAST_1
US_EAST_1
US_WEST_1
US_WEST_2

Field Summary

Fields

Modifier and Type	Field and Description
static Regions	DEFAULT_REGION The default region that new customers in the US are encouraged to use when using AWS services for the first time.

Method Summary

Methods

Modifier and Type	Method and Description
static Regions	fromName(String regionName) Returns a region enum corresponding to the given region name.
static Region	getCurrentRegion() Returns a Region object representing the region the application is running in, when running in EC2.
String	getName() The name of this region, used in the regions.xml file to identify it.
static Regions	valueOf(String name) Returns the enum constant of this type with the specified name.
static Regions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GovCloud

public static final Regions GovCloud

US_EAST_1

public static final Regions US_EAST_1

US_WEST_1

public static final Regions US_WEST_1

US_WEST_2

public static final Regions US_WEST_2

EU_WEST_1

public static final Regions EU_WEST_1

EU_CENTRAL_1

public static final Regions EU_CENTRAL_1

AP_SOUTHEAST_1

public static final Regions AP_SOUTHEAST_1

AP_SOUTHEAST_2

public static final Regions AP_SOUTHEAST_2

AP_NORTHEAST_1

public static final Regions AP_NORTHEAST_1

SA_EAST_1

public static final Regions SA_EAST_1

CN_NORTH_1

public static final Regions CN_NORTH_1

Field Detail

DEFAULT_REGION

public static final Regions DEFAULT_REGION

The default region that new customers in the US are encouraged to use when using AWS services for the first time.

Method Detail

values

public static Regions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Regions c : Regions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Regions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

The name of this region, used in the regions.xml file to identify it.

fromName

public static Regions fromName(String regionName)

Returns a region enum corresponding to the given region name.

Parameters:

regionName - The name of the region. Ex.: eu-west-1

Returns:

Region enum representing the given region name.

getCurrentRegion

public static Region getCurrentRegion()

Returns a Region object representing the region the application is running in, when running in EC2. If this method is called from a non-EC2 environment, it will return null.