software.amazon.awssdk.regions

Class Region

java.lang.Object

software.amazon.awssdk.regions.Region

public final class Region
extends Object

An Amazon Web Services region that hosts a set of Amazon services.

An instance of this class can be retrieved by referencing one of the static constants defined in this class (eg. US_EAST_1) or by using the of(String) method if the region you want is not included in this release of the SDK.

Each AWS region corresponds to a separate geographical location where a set of Amazon services is deployed. These regions (except for the special AWS_GLOBAL and AWS_CN_GLOBAL regions) are separate from each other, with their own set of resources. This means a resource created in one region (eg. an SQS queue) is not available in another region.

To programmatically determine whether a particular service is deployed to a region, you can use the serviceMetadata method on the service's client interface. Additional metadata about a region can be discovered using RegionMetadata.of(Region).

The id() will be used as the signing region for all requests to AWS services unless an explicit region override is available in RegionMetadata. This id will also be used to construct the endpoint for accessing a service unless an explicit endpoint is available for that region in RegionMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
static Region	AP_NORTHEAST_1
static Region	AP_NORTHEAST_2
static Region	AP_SOUTH_1
static Region	AP_SOUTHEAST_1
static Region	AP_SOUTHEAST_2
static Region	AWS_CN_GLOBAL
static Region	AWS_GLOBAL
static Region	AWS_US_GOV_GLOBAL
static Region	CA_CENTRAL_1
static Region	CN_NORTH_1
static Region	CN_NORTHWEST_1
static Region	EU_CENTRAL_1
static Region	EU_WEST_1
static Region	EU_WEST_2
static Region	EU_WEST_3
static Region	SA_EAST_1
static Region	US_EAST_1
static Region	US_EAST_2
static Region	US_GOV_WEST_1
static Region	US_WEST_1
static Region	US_WEST_2

Method Summary

Modifier and Type	Method and Description
String	id()
boolean	isGlobalRegion()
static Region	of(String value) Load the region associated with the provided region name.
static List<Region>	regions() Retrieve an unmodifiable list of the public regions in this release of the AWS SDK.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AP_NORTHEAST_1

public static final Region AP_NORTHEAST_1

AP_NORTHEAST_2

public static final Region AP_NORTHEAST_2

AP_SOUTH_1

public static final Region AP_SOUTH_1

AP_SOUTHEAST_1

public static final Region AP_SOUTHEAST_1

AP_SOUTHEAST_2

public static final Region AP_SOUTHEAST_2

CA_CENTRAL_1

public static final Region CA_CENTRAL_1

EU_CENTRAL_1

public static final Region EU_CENTRAL_1

EU_WEST_1

public static final Region EU_WEST_1

EU_WEST_2

public static final Region EU_WEST_2

EU_WEST_3

public static final Region EU_WEST_3

SA_EAST_1

public static final Region SA_EAST_1

US_EAST_1

public static final Region US_EAST_1

US_EAST_2

public static final Region US_EAST_2

US_WEST_1

public static final Region US_WEST_1

US_WEST_2

public static final Region US_WEST_2

AWS_GLOBAL

public static final Region AWS_GLOBAL

CN_NORTH_1

public static final Region CN_NORTH_1

CN_NORTHWEST_1

public static final Region CN_NORTHWEST_1

AWS_CN_GLOBAL

public static final Region AWS_CN_GLOBAL

US_GOV_WEST_1

public static final Region US_GOV_WEST_1

AWS_US_GOV_GLOBAL

public static final Region AWS_US_GOV_GLOBAL

Method Detail

of

public static Region of(String value)

Load the region associated with the provided region name.

This API is idempotent and will always return the same region instance if the same input value is provided. For example, the following conditions will always evaluated to true: Region.of("us-east-1") == Region.of("us-east-1"), Region.US_EAST_1 == Region.of("us-east-1").

Parameters:

value - The name of the region to load. Can't be null, empty or blank

Returns:

The region associated with the provided name.

id

public String id()

Returns:

the unique identifier for the region

regions

public static List<Region> regions()

Retrieve an unmodifiable list of the public regions in this release of the AWS SDK.

isGlobalRegion

public boolean isGlobalRegion()

toString

public String toString()

Overrides:

toString in class Object