Region Property

The region that the class will make requests against.

Syntax

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_AMAZONSECRETS_REGION 26

CLOUDKEYS_EXTERNAL void* CLOUDKEYS_CALL CloudKeys_AmazonSecrets_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AmazonSecrets_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. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed in order to create or access resources in other regions, as secrets are region-specific resources.

Regions:

Value Region
us-east-1 (Default) US East (N. Virginia)
us-east-2 US East (Ohio)
us-west-1 US West (N. California)
us-west-2 US West (Oregon)
af-south-1 Africa (Cape Town)
ap-east-1 Asia Pacific (Hong Kong)
ap-northeast-1 Asia Pacific (Tokyo)
ap-northeast-2 Asia Pacific (Seoul)
ap-northeast-3 Asia Pacific (Osaka-Local)
ap-south-1 Asia Pacific (Mumbai)
ap-southeast-1 Asia Pacific (Singapore)
ap-southeast-2 Asia Pacific (Sydney)
ca-central-1 Canada (Central)
cn-north-1 China (Beijing)
cn-northwest-1 China (Ningxia)
eu-central-1 Europe (Frankfurt)
eu-north-1 Europe (Stockholm)
eu-south-1 Europe (Milan)
eu-west-1 Europe (Ireland)
eu-west-2 Europe (London)
eu-west-3 Europe (Paris)
me-south-1 Middle East (Bahrain)
sa-east-1 South America (Sao Paulo)
us-gov-east-1 AWS GovCloud (US East)
us-gov-west-1 AWS GovCloud (US West)

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.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 C++ Edition - Version 20.0 [Build 8157]