com.amazonaws.regions

Class Region

java.lang.Object

com.amazonaws.regions.Region

public final class Region
extends Object

Metadata for an AWS region, including its name and what services are available in it.

Method Summary

Modifier and Type	Method and Description
<T extends AmazonWebServiceClient> T	createClient(Class<T> serviceClass, AWSCredentialsProvider credentials, ClientConfiguration config) Creates a new service client of the class given and configures it.
boolean	equals(Object obj)
String	getDomain() Returns the domain for this region; ex: "amazonaws.com".
String	getName() The unique system ID for this region; ex: "us-east-1".
static Region	getRegion(Regions region)
static Region	getRegion(String regionString)
String	getServiceEndpoint(String serviceName)
int	hashCode()
boolean	hasHttpEndpoint(String serviceName)
boolean	hasHttpsEndpoint(String serviceName)
boolean	isServiceSupported(String serviceName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRegion

public static Region getRegion(Regions region)

Parameters:

region - the region.

Returns:

the region with the id given, or null if it cannot be found in the current regions.xml file.

getRegion

public static Region getRegion(String regionString)

Parameters:

regionString - the region represented as a string. i.e. us-east-1

Returns:

the region with the id given, or null if it cannot be found in the current regions.xml file.

getName

public String getName()

The unique system ID for this region; ex: "us-east-1".

Returns:

The unique system ID for this region.

getDomain

public String getDomain()

Returns the domain for this region; ex: "amazonaws.com".

Returns:

The domain for this region.

getServiceEndpoint

public String getServiceEndpoint(String serviceName)

Parameters:

serviceName - the service name.

Returns:

the endpoint for the service given.

See Also:

ServiceAbbreviations

isServiceSupported

public boolean isServiceSupported(String serviceName)

Parameters:

serviceName - the service name.

Returns:

whether the given service is supported in this region.

See Also:

ServiceAbbreviations

hasHttpsEndpoint

public boolean hasHttpsEndpoint(String serviceName)

Parameters:

serviceName - the service name.

Returns:

whether the given service support the https protocol in this region.

See Also:

ServiceAbbreviations

hasHttpEndpoint

public boolean hasHttpEndpoint(String serviceName)

Parameters:

serviceName - the service name.

Returns:

whether the given service support the http protocol in this region.

See Also:

ServiceAbbreviations

createClient

public <T extends AmazonWebServiceClient> T createClient(Class<T> serviceClass,
                                                         AWSCredentialsProvider credentials,
                                                         ClientConfiguration config)

Creates a new service client of the class given and configures it. If credentials or config are null, defaults will be used.

Type Parameters:

T - the AmazonWebServiceClient type.

Parameters:

serviceClass - The service client class to instantiate, e.g. AmazonS3Client.class

credentials - The credentials provider to use, or null for the default credentials provider

config - The configuration to use, or null for the default configuration

Returns:

the AmazonWebServiceClient.

See Also:

ServiceAbbreviations

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object