Open 3D Engine AWSCore Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AWSCore::AWSResourceMappingManager Class Reference

#include <AWSResourceMappingManager.h>

Inherits AWSResourceMappingRequestBus::Handler.

Public Types

enum class  Status : AZ::u8 { NotLoaded = 0 , Ready = 1 , Error = 2 }
 

Public Member Functions

void ActivateManager ()
 
void DeactivateManager ()
 
AZStd::string GetDefaultAccountId () const override
 
AZStd::string GetDefaultRegion () const override
 
bool HasResource (const AZStd::string &resourceKeyName) const override
 
AZStd::string GetResourceAccountId (const AZStd::string &resourceKeyName) const override
 
AZStd::string GetResourceNameId (const AZStd::string &resourceKeyName) const override
 
AZStd::string GetResourceRegion (const AZStd::string &resourceKeyName) const override
 
AZStd::string GetResourceType (const AZStd::string &resourceKeyName) const override
 
AZStd::string GetServiceUrlByServiceName (const AZStd::string &serviceName) const override
 
AZStd::string GetServiceUrlByRESTApiIdAndStage (const AZStd::string &restApiIdKeyName, const AZStd::string &restApiStageKeyName) const override
 
void ReloadConfigFile (bool reloadConfigFileName=false) override
 
Status GetStatus () const
 

Static Public Attributes

static constexpr const char AWSResourceMappingManagerName [] = "AWSResourceMappingManager"
 
static constexpr const char ManagerUnexpectedStatusErrorMessage []
 
static constexpr const char ResourceMappingFileInvalidPathErrorMessage []
 
static constexpr const char ResourceMappingKeyNotFoundErrorMessage []
 
static constexpr const char ResourceMappingFileNotLoadedErrorMessage []
 
static constexpr const char ResourceMappingFileLoadFailureErrorMessage []
 
static constexpr const char ResourceMappingRESTApiIdAndStageInconsistentErrorMessage []
 
static constexpr const char ResourceMappingRESTApiInvalidServiceUrlErrorMessage []
 
static constexpr const char ResourceMappingFileInvalidJsonFormatErrorMessage []
 
static constexpr const char ResourceMappingFileInvalidSchemaErrorMessage []
 
static constexpr const char ResourceMappingFileInvalidContentErrorMessage []
 

Detailed Description

AWSResourceMappingManager is the manager holding AWS resource mapping data. The manager provides mapping key based AWS resource attributes lookups, and API to reload AWS resource mapping data synchronously. The manager doesn't support to modify or update AWS resource mapping data.

Member Data Documentation

◆ ManagerUnexpectedStatusErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ManagerUnexpectedStatusErrorMessage[]
staticconstexpr
Initial value:
=
"AWSResourceMappingManager is in unexpected status."

◆ ResourceMappingFileInvalidContentErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingFileInvalidContentErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to parse resource mapping config file: %s"

◆ ResourceMappingFileInvalidJsonFormatErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingFileInvalidJsonFormatErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to read resource mapping config file: %s"

◆ ResourceMappingFileInvalidPathErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingFileInvalidPathErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to get resource mapping config file path."

◆ ResourceMappingFileInvalidSchemaErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingFileInvalidSchemaErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to load resource mapping config file json schema."

◆ ResourceMappingFileLoadFailureErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingFileLoadFailureErrorMessage[]
staticconstexpr
Initial value:
=
"Resource mapping config file failed to load, please confirm file is present and in correct format."

◆ ResourceMappingFileNotLoadedErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingFileNotLoadedErrorMessage[]
staticconstexpr
Initial value:
=
"Resource mapping config file is not loaded, please confirm %s is setup correctly."

◆ ResourceMappingKeyNotFoundErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingKeyNotFoundErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to find resource mapping key: %s"

◆ ResourceMappingRESTApiIdAndStageInconsistentErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingRESTApiIdAndStageInconsistentErrorMessage[]
staticconstexpr
Initial value:
=
"Resource mapping %s and %s have inconsistent region value, return empty service url."

◆ ResourceMappingRESTApiInvalidServiceUrlErrorMessage

constexpr const char AWSCore::AWSResourceMappingManager::ResourceMappingRESTApiInvalidServiceUrlErrorMessage[]
staticconstexpr
Initial value:
=
"Unable to format REST Api url with RESTApiId=%s, RESTApiRegion=%s, RESTApiStage=%s, return empty service url."

The documentation for this class was generated from the following file: