Region (Amazon S3 Connector - Mule 3 4.3.4 API)

java.lang.Object
- java.lang.Enum<Region>
- - org.mule.module.s3.model.Region

All Implemented Interfaces:

Serializable, Comparable<Region>
```
public enum Region
extends Enum<Region>
```
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.

In Amazon S3, all the regions provides read-after-write consistency for PUTS of new objects in Amazon S3 buckets and eventual consistency for overwrite PUTS and DELETES.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AP_MUMBAI` The Asia Pacific (Mumbai) Region.
`AP_SEOUL` The Asia Pacific (Seoul) Region.
`AP_SINGAPORE` The Asia Pacific (Singapore) Region.
`AP_SYDNEY` The Asia Pacific (Sydney) Region.
`AP_TOKYO` The Asia Pacific (Tokyo) Region.
`CA_CENTRAL` The Canada (Central) Region.
`CN_BEIJING` The China (Beijing) Region.
`CN_NORTHWEST_1` The China (Ningxia) Region.
`EU_FRANKFURT` The EU (Frankfurt) Amazon S3 Region.
`EU_IRELAND` The EU (Ireland) Amazon S3 Region.
`EU_LONDON` The EU (London) Amazon S3 Region.
`EU_NORTH_1` The EU (Stockholm) Amazon S3 Region.
`EU_PARIS` The EU (Paris) Amazon S3 Region.
`SA_SAOPAULO` The South America (Sao Paulo) Region.
`US_EAST_2` The US-East-2 (Ohio) Region.
`US_GOV_EAST_1` The US GovCloud (East) Region.
`US_GOVCLOUD` The US GovCloud Region.
`US_STANDARD` The US Standard Amazon S3 Region.
`US_WEST` The US-West (Northern California) Amazon S3 Region.
`US_WEST_2` The US-West-2 (Oregon) Region.

Field Summary

Fields
Modifier and Type Field and Description

static Pattern S3_REGIONAL_ENDPOINT_PATTERN
Used to extract the S3 regional id from an S3 end point.

Fields
Modifier and Type	Field and Description
`static Pattern`	`S3_REGIONAL_ENDPOINT_PATTERN` Used to extract the S3 regional id from an S3 end point.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`toAWSRegion()` Returns the respective AWS region.
`String`	`toString()`
`static Region`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Region[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - US_STANDARD
```
public static final Region US_STANDARD
```
    The US Standard Amazon S3 Region. This region is equivalent to 'us-east-1', see Amazon Simple Storage Service (S3) FAQs for more information.
    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.
  - US_EAST_2
```
public static final Region US_EAST_2
```
    The US-East-2 (Ohio) Region. This region uses Amazon S3 servers located in Ohio.
    When using buckets in this region, set the client endpoint to s3.us-east-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.
  - US_WEST
```
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.
  - US_WEST_2
```
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.
  - US_GOVCLOUD
```
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.
  - US_GOV_EAST_1
```
public static final Region US_GOV_EAST_1
```
    The US GovCloud (East) Region.
  - EU_IRELAND
```
public static final Region EU_IRELAND
```
    The EU (Ireland) Amazon S3 Region. This region uses Amazon S3 servers located in Ireland.
  - EU_LONDON
```
public static final Region EU_LONDON
```
    The EU (London) Amazon S3 Region. This region uses Amazon S3 servers located in London.
  - EU_PARIS
```
public static final Region EU_PARIS
```
    The EU (Paris) Amazon S3 Region. This region uses Amazon S3 servers located in Paris.
  - EU_FRANKFURT
```
public static final Region EU_FRANKFURT
```
    The EU (Frankfurt) Amazon S3 Region. This region uses Amazon S3 servers located in Frankfurt.
    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"));
 
```
  - EU_NORTH_1
```
public static final Region EU_NORTH_1
```
    The EU (Stockholm) Amazon S3 Region. This region uses Amazon S3 servers located in Stockholm.
  - AP_SINGAPORE
```
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.
  - AP_SYDNEY
```
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.
  - AP_TOKYO
```
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.
  - AP_SEOUL
```
public static final Region AP_SEOUL
```
    The Asia Pacific (Seoul) Region. This region uses Amazon S3 servers located in Seoul.
    When using buckets in this region, set the client endpoint to s3.ap-northeast-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.
  - AP_MUMBAI
```
public static final Region AP_MUMBAI
```
    The Asia Pacific (Mumbai) Region. This region uses Amazon S3 servers located in Mumbai.
    When using buckets in this region, set the client endpoint to s3.ap-south-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.
  - SA_SAOPAULO
```
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.
  - CA_CENTRAL
```
public static final Region CA_CENTRAL
```
    The Canada (Central) Region. This region uses Amazon S3 servers located in Canada.
    When using buckets in this region, set the client endpoint to s3.ca-central-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.
  - CN_BEIJING
```
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.
  - CN_NORTHWEST_1
```
public static final Region CN_NORTHWEST_1
```
    The China (Ningxia) Region. This region uses Amazon S3 servers located in Ningxia.
    When using buckets in this region, you must set the client endpoint to s3.cn-northwest-1.amazonaws.com.cn.
- Field Detail
  - S3_REGIONAL_ENDPOINT_PATTERN
```
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
 
```
- Method Detail
  - values
```
public static Region[] 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 (Region c : Region.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Region 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<Region>
  - getFirstRegionId
```
public String getFirstRegionId()
```
    Returns the first region id or null for US_STANDARD.
    
    Returns:
    
    The first region id or null for US_STANDARD.
  - fromValue
```
public static Region fromValue(String s3RegionId)
                        throws IllegalArgumentException
```
    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.
  - toAWSRegion
```
public String toAWSRegion()
```
    Returns the respective AWS region.
    
    Returns:
    
    the respective AWS region.

Enum Region

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

US_STANDARD

US_EAST_2

US_WEST

US_WEST_2

US_GOVCLOUD

US_GOV_EAST_1

EU_IRELAND

EU_LONDON

EU_PARIS

EU_FRANKFURT

EU_NORTH_1

AP_SINGAPORE

AP_SYDNEY

AP_TOKYO

AP_SEOUL

AP_MUMBAI

SA_SAOPAULO

CA_CENTRAL

CN_BEIJING

CN_NORTHWEST_1

Field Detail

S3_REGIONAL_ENDPOINT_PATTERN

Method Detail

values

valueOf

toString

getFirstRegionId

fromValue

toAWSRegion