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.
Public Types | Public Member Functions | Static Public Attributes | List of all members
AWSCore::AWSResourceMappingRequests Class Referenceabstract

AWSResourceMapping request interface. More...

#include <AWSResourceMappingBus.h>

Inherits AZ::EBusTraits.

Public Types

using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual AZStd::string GetDefaultAccountId () const =0
 
virtual AZStd::string GetDefaultRegion () const =0
 
virtual bool HasResource (const AZStd::string &resourceKeyName) const =0
 
virtual AZStd::string GetResourceAccountId (const AZStd::string &resourceKeyName) const =0
 
virtual AZStd::string GetResourceNameId (const AZStd::string &resourceKeyName) const =0
 
virtual AZStd::string GetResourceRegion (const AZStd::string &resourceKeyName) const =0
 
virtual AZStd::string GetResourceType (const AZStd::string &resourceKeyName) const =0
 
virtual AZStd::string GetServiceUrlByServiceName (const AZStd::string &serviceName) const =0
 
virtual AZStd::string GetServiceUrlByRESTApiIdAndStage (const AZStd::string &restApiIdKeyName, const AZStd::string &restApiStageKeyName) const =0
 
virtual void ReloadConfigFile (bool isReloadingConfigFileName)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Detailed Description

AWSResourceMapping request interface.

Member Function Documentation

◆ GetDefaultAccountId()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetDefaultAccountId ( ) const
pure virtual

GetDefaultAccountId Get default account id which is shared among resources

Returns
Default account id in string

◆ GetDefaultRegion()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetDefaultRegion ( ) const
pure virtual

GetDefaultRegion Get default region which is shared among resources

Returns
Default region in string

◆ GetResourceAccountId()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetResourceAccountId ( const AZStd::string &  resourceKeyName) const
pure virtual

GetResourceAccountId Get individual resource account id by using its mapping key name. If resource account id is not present in resource attributes, will use default account id instead

Parameters
resourceKeyNameResource mapping key name is used to identify individual resource attributes
Returns
Resource account id in string

◆ GetResourceNameId()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetResourceNameId ( const AZStd::string &  resourceKeyName) const
pure virtual

GetResourceNameId Get individual resource name/id by using its mapping key name

Parameters
resourceKeyNameResource mapping key name is used to identify individual resource attributes
Returns
Resource name/id in string

◆ GetResourceRegion()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetResourceRegion ( const AZStd::string &  resourceKeyName) const
pure virtual

GetResourceRegion Get individual resource region by using its mapping key name. If resource region is not present in resource attributes, will use default region instead

Parameters
resourceKeyNameResource mapping key name is used to identify individual resource attributes
Returns
Resource region in string

◆ GetResourceType()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetResourceType ( const AZStd::string &  resourceKeyName) const
pure virtual

GetResourceType Get individual resource type by using its mapping key name

Parameters
resourceKeyNameResource mapping key name is used to identify individual resource attributes
Returns
Resource type in string

◆ GetServiceUrlByRESTApiIdAndStage()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetServiceUrlByRESTApiIdAndStage ( const AZStd::string &  restApiIdKeyName,
const AZStd::string &  restApiStageKeyName 
) const
pure virtual

GetServiceUrl Returns the base url for a registered APIGateway service endpoint

Parameters
restApiIdKeyNameThe resource key name of APIGateway service REST Api id
restApiStageKeyNameThe resource key name of APIGateway service REST Api stage
Returns
the service URL without a trailing / character

◆ GetServiceUrlByServiceName()

virtual AZStd::string AWSCore::AWSResourceMappingRequests::GetServiceUrlByServiceName ( const AZStd::string &  serviceName) const
pure virtual

GetServiceUrl Returns the base url for a registered APIGateway service endpoint

Parameters
serviceNameThe name of the Gem or mapping name that provides the services
Returns
the service URL without a trailing / character

◆ HasResource()

virtual bool AWSCore::AWSResourceMappingRequests::HasResource ( const AZStd::string &  resourceKeyName) const
pure virtual

HasResource Check if an AWS resource is defined

Parameters
resourceKeyNameResource mapping key name is used to identify individual resource attributes
Returns
True if the resource exists; otherwise false.

◆ ReloadConfigFile()

virtual void AWSCore::AWSResourceMappingRequests::ReloadConfigFile ( bool  isReloadingConfigFileName)
pure virtual

ReloadConfigFile Reload resource mapping config file without restarting application

Parameters
isReloadingConfigFileNameWhether reload resource mapping config file name from AWS core configuration settings registry file
The documentation for this class was generated from the following file: