AwsRegion Class

const AwsRegion region(AwsRegion::AP_Northeast_1);
region.name();          // "ap-northeast-1"
region.fullName();      // "Asia Pacific (Tokyo) Region"
region.hostName("iam"); // "iam.amazonaws.com"

Member Function Documentation

AwsRegion::AwsRegion(const Region region)

Constructs an AwsRegion object for AWS region.

AwsRegion::AwsRegion(const QString &regionName)

Constructs an AwsRegion object for AWS regionName.

If regionName is not recognised as a valid AWS region, isValid() will return false.

AwsRegion::~AwsRegion()

Destroys the AWS region.

[static] Region AwsRegion::fromName(const QString &regionName)

Returns the AwsRegion::Region enum value for regionName, or InvalidRegion if not a valid region name.

regionName is not case sensitive.

QString AwsRegion::fullName() const

Returns the full name for this AWS region.

This returns a humand-readable name for this object's region. For example, for the AwsRegion::US_East_1 region, this will return something like "US East (Northern Virginia) Region".

These full names were gleaned from http://aws.amazon.com/about-aws/globalinfrastructure/ and http://docs.aws.amazon.com/general/latest/gr/rande.html.

[static] QString AwsRegion::fullName(const Region &region)

Returns the full name for AWS region.

This returns a humand-readable name for the specified AWS region. For example, for the AwsRegion::US_East_1 region, this will return something like "US East (Northern Virginia) Region".

These full names were gleaned from http://aws.amazon.com/about-aws/globalinfrastructure/ and http://docs.aws.amazon.com/general/latest/gr/rande.html.

QString AwsRegion::hostName(const QString &serviceName) const

Returns the name of the host that supports serviceName for this region, or a null string if the service is not supported for this region.

bool AwsRegion::isSupported(const QString &serviceName, const AwsEndpoint::Transports transports = AwsEndpoint::AnyTransport) const

Returns true if serviceName is supported for this region, for at least one of the specified transports; false otherwise.

bool AwsRegion::isValid() const

Returns true if this region is valid; false otherwise.

Any AwsRegion object created using one of the valid AwsRegion::Region enumeration values (ie any but AwsRegion::InvalidRegion) will be considered valid.

However, if an unknown region name is supplied to the overloaded AwsRegion(const QString &regionName) constructor, then the constructed object will be considered invalid.

QString AwsRegion::name() const

Returns the canonical AWS name for this region, or a null string if invalid.

See also isValid.

[static] QString AwsRegion::name(const Region &region)

Returns the canonical AWS name for region.

Region AwsRegion::region() const

Returns the region as an AwsRegion::Region enum, or AwsRegion::InvalidRegion if the region is invalid.

If this object was given an AwsRegion::Region value during construction, this function will simply return that enumeration value.

If this object was constructed from an AWS region name, then this function will return the AwsRegion::Region enumeration value corresponding to that AWS region name, or AwsRegion::InvalidRegion if the given region name did not name a known, valid AWS region.

QStringList AwsRegion::supportedServices(const AwsEndpoint::Transports transports = AwsEndpoint::AnyTransport) const

Returns the list of the names of all AWS services support by this region for at least one of the specified transports. The list may be empty.