public final enum

Region

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ org.mule.module.s3.model.Region

Class Overview

Specifies constants that define Amazon S3 Regions.

Amazon S3 Regions allow the user to choose the geographical region where Amazon S3 will store the buckets the user creates. Choose a Amazon S3 Region to optimize latency, minimize costs, or address regulatory requirements.

Objects stored in a Amazon S3 Region never leave that region unless explicitly transferred to another region.

Summary

Enum Values
Region  AP_SINGAPORE  The Asia Pacific (Singapore) Region. 
Region  AP_SYDNEY  The Asia Pacific (Sydney) Region. 
Region  AP_TOKYO  The Asia Pacific (Tokyo) Region. 
Region  CN_BEIJING  The China (Beijing) Region. 
Region  EU_FRANKFURT  The EU (Frankfurt) Amazon S3 Region. 
Region  EU_IRELAND  The EU (Ireland) Amazon S3 Region. 
Region  SA_SAOPAULO  The South America (Sao Paulo) Region. 
Region  US_GOVCLOUD  The US GovCloud Region. 
Region  US_STANDARD  The US Standard Amazon S3 Region. 
Region  US_WEST  The US-West (Northern California) Amazon S3 Region. 
Region  US_WEST_2  The US-West-2 (Oregon) Region. 
Fields
public static final Pattern S3_REGIONAL_ENDPOINT_PATTERN Used to extract the S3 regional id from an S3 end point.
private final List<String> regionIds The list of ID's representing each region.
[Expand]
Inherited Fields
From class java.lang.Enum
Public Methods
static Region fromValue(String s3RegionId)
Returns the Amazon S3 Region enumeration value representing the specified Amazon S3 Region ID string.
String getFirstRegionId()
Returns the first region id or null for US_STANDARD.
String toString()
static Region valueOf(String name)
final static Region[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum Values

public static final Region AP_SINGAPORE

The Asia Pacific (Singapore) Region. This region uses Amazon S3 servers located in Singapore.

When using buckets in this region, set the client endpoint to s3-ap-southeast-1.amazonaws.com on all requests to these buckets to reduce any latency experienced after the first hour of creating a bucket in this region.

public static final Region AP_SYDNEY

The Asia Pacific (Sydney) Region. This region uses Amazon S3 servers located in Sydney, Australia.

When using buckets in this region, set the client endpoint to s3-ap-southeast-2.amazonaws.com on all requests to these buckets to reduce any latency experienced after the first hour of creating a bucket in this region.

public static final Region AP_TOKYO

The Asia Pacific (Tokyo) Region. This region uses Amazon S3 servers located in Tokyo.

When using buckets in this region, set the client endpoint to s3-ap-northeast-1.amazonaws.com on all requests to these buckets to reduce any latency experienced after the first hour of creating a bucket in this region.

public static final Region CN_BEIJING

The China (Beijing) Region. This region uses Amazon S3 servers located in Beijing.

When using buckets in this region, you must set the client endpoint to s3.cn-north-1.amazonaws.com.cn.

public static final Region EU_FRANKFURT

The EU (Frankfurt) Amazon S3 Region. This region uses Amazon S3 servers located in Frankfurt.

In Amazon S3, the EU (Frankfurt) Region provides read-after-write consistency for PUTS of new objects in Amazon S3 buckets and eventual consistency for overwrite PUTS and DELETES.

The EU (Frankfurt) Region requires AWS V4 authentication, therefore when accessing buckets inside this region, you need to explicitly configure the "eu-central-1" endpoint for the AmazonS3Client in order to enable V4 signing: 

 AmazonS3Client s3 = new AmazonS3Client();
 s3.setRegion(RegionUtils.getRegion("eu-central-1"));

public static final Region EU_IRELAND

The EU (Ireland) Amazon S3 Region. This region uses Amazon S3 servers located in Ireland.

In Amazon S3, the EU (Ireland) Region provides read-after-write consistency for PUTS of new objects in Amazon S3 buckets and eventual consistency for overwrite PUTS and DELETES.

public static final Region SA_SAOPAULO

The South America (Sao Paulo) Region. This region uses Amazon S3 servers located in Sao Paulo.

When using buckets in this region, set the client endpoint to s3-sa-east-1.amazonaws.com on all requests to these buckets to reduce any latency experienced after the first hour of creating a bucket in this region.

public static final Region US_GOVCLOUD

The US GovCloud Region. This region uses Amazon S3 servers located in the Northwestern region of the United States.

public static final Region US_STANDARD

The US Standard Amazon S3 Region. This region uses Amazon S3 servers located in the United States.

This is the default Amazon S3 Region. All requests sent to s3.amazonaws.com go to this region unless a location constraint is specified when creating a bucket. The US Standard Region automatically places data in either Amazon's east or west coast data centers depending on which one provides the lowest latency. The US Standard Region provides eventual consistency for all requests.

public static final Region US_WEST

The US-West (Northern California) Amazon S3 Region. This region uses Amazon S3 servers located in Northern California.

When using buckets in this region, set the client endpoint to s3-us-west-1.amazonaws.com on all requests to these buckets to reduce any latency experienced after the first hour of creating a bucket in this region.

In Amazon S3, the US-West (Northern California) Region provides read-after-write consistency for PUTS of new objects in Amazon S3 buckets and eventual consistency for overwrite PUTS and DELETES.

public static final Region US_WEST_2

The US-West-2 (Oregon) Region. This region uses Amazon S3 servers located in Oregon.

When using buckets in this region, set the client endpoint to s3-us-west-2.amazonaws.com on all requests to these buckets to reduce any latency experienced after the first hour of creating a bucket in this region.

Fields

public static final Pattern S3_REGIONAL_ENDPOINT_PATTERN

Used to extract the S3 regional id from an S3 end point. Note this pattern will not match the S3 US standard endpoint by intent. Exampless: 

 s3-eu-west-1.amazonaws.com
 s3.cn-north-1.amazonaws.com.cn

private final List<String> regionIds

The list of ID's representing each region.

Public Methods

public static Region fromValue (String s3RegionId)

Returns the Amazon S3 Region enumeration value representing the specified Amazon S3 Region ID string. If specified string doesn't map to a known Amazon S3 Region, then an IllegalArgumentException is thrown.

Parameters
s3RegionId The Amazon S3 region ID string.
Returns
  • The Amazon S3 Region enumeration value representing the specified Amazon S3 Region ID.
Throws
IllegalArgumentException If the specified value does not map to one of the known Amazon S3 regions.

public String getFirstRegionId ()

Returns the first region id or null for US_STANDARD.

public String toString ()

public static Region valueOf (String name)

Parameters
name

public static final Region[] values ()