Region Property

The region the class will make requests against.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetRegion();
int SetRegion(const char* lpszRegion);

Unicode (Windows)
LPWSTR GetRegion();
INT SetRegion(LPCWSTR lpszRegion);

@property (nonatomic,readwrite,assign,getter=region,setter=setRegion:) NSString* region;
- (NSString*)region;
- (void)setRegion:(NSString*)newRegion;

#define PID_S3CLIENT_REGION 67

IPWORKSS3_EXTERNAL void* IPWORKSS3_CALL IPWorksS3_S3Client_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSS3_EXTERNAL int IPWORKSS3_CALL IPWorksS3_S3Client_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

"us-east-1"

Remarks

This property controls which region the class will make requests against; it should be changed to create or access resources in other regions.

Each service provider has a different default region, and the class will automatically set this property to the selected service provider's default region anytime ServiceProvider changes. The custom service provider's "default region" is empty string (i.e., setting ServiceProvider to spCustom (255) will clear this property).

Note: When the custom service provider is selected, the class uses the base URL specified by the URL configuration setting to generate request URLs. If the base URL contains a %region% token, the class will replace it with this property's value anytime it generates a request URL. Refer to the URL setting's documentation for more information.

Amazon S3 Regions

Alibaba Cloud Object Storage Regions

Backblaze B2 Regions

All BackblazeB2 region strings take the form us-west-###, where ### is a 3-digit number. By default, the class uses us-west-000.

To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string.

Note: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a non-master application key if necessary.

Digital Ocean Spaces Regions

Google Cloud Storage Regions

(* denotes a multi-regional location)

Huawei Cloud Object Storage Regions

IBM Cloud Object Storage Regions

Note that private. or direct. may optionally be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.

Linode Object Storage Regions

Important: Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters do not interact with each other in any way, which causes the following non-standard behaviors:

• Bucket names may be reused in each region (however, they must still be "globally" unique within each region).
• The ListBuckets method will only return buckets located in the currently-selected region; there is no way to retrieve a list of all regions' buckets.
• Similarly, the BucketExists and GetBucketLocation methods only consider buckets located in the currently-selected region.
• The CopyObject method cannot be used to copy objects to a bucket in another region.

Oracle Cloud Object Storage Regions

Wasabi Regions

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value for the currently-selected ServiceProvider.

Data Type

String