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::AWSCoreConfiguration Class Reference

#include <AWSCoreConfiguration.h>

Inherits AWSCoreInternalRequestBus::Handler.

Public Member Functions

void ActivateConfig ()
 
void DeactivateConfig ()
 
void InitConfig ()
 
AZStd::string GetResourceMappingConfigFilePath () const override
 
AZStd::string GetProfileName () const override
 
bool IsAllowedAWSMetadataCredentials () const override
 
void ReloadConfiguration () override
 

Static Public Attributes

static constexpr const char AWSCoreConfigurationName [] = "AWSCoreConfiguration"
 
static constexpr const char AWSCoreConfigurationFileName [] = "awscoreconfiguration.setreg"
 
static constexpr const char AWSCoreResourceMappingConfigFolderName [] = "Config"
 
static constexpr const char AWSCoreResourceMappingConfigFileNameKey [] = "/AWSCore/ResourceMappingConfigFileName"
 
static constexpr const char AWSCoreDefaultProfileName [] = "default"
 
static constexpr const char AWSCoreProfileNameKey [] = "/AWSCore/ProfileName"
 
static constexpr const char AWSCoreAllowAWSMetadataCredentialsKey [] = "/AWSCore/AllowAWSMetadataCredentials"
 
static constexpr const char ProjectSourceFolderNotFoundErrorMessage []
 
static constexpr const char ProfileNameNotFoundErrorMessage []
 
static constexpr const char ResourceMappingFileNameNotFoundErrorMessage []
 
static constexpr const char SettingsRegistryFileLoadFailureErrorMessage []
 
static constexpr const char GlobalSettingsRegistryLoadFailureErrorMessage []
 
static constexpr const char AllowAWSMetadataCredentialsNotFoundMessage []
 

Detailed Description

Responsible for handling configuration for AWSCore gem TODO: Expose internal field through edit behavior if required

Member Data Documentation

◆ AllowAWSMetadataCredentialsNotFoundMessage

constexpr const char AWSCore::AWSCoreConfiguration::AllowAWSMetadataCredentialsNotFoundMessage[]
staticconstexpr
Initial value:
=
"Failed to get AllowAWSMetadataCredentials setting, will default to false."

◆ GlobalSettingsRegistryLoadFailureErrorMessage

constexpr const char AWSCore::AWSCoreConfiguration::GlobalSettingsRegistryLoadFailureErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to load AWSCore configurations from global settings registry."

◆ ProfileNameNotFoundErrorMessage

constexpr const char AWSCore::AWSCoreConfiguration::ProfileNameNotFoundErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to get profile name, return default value instead."

◆ ProjectSourceFolderNotFoundErrorMessage

constexpr const char AWSCore::AWSCoreConfiguration::ProjectSourceFolderNotFoundErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to get project source folder path."

◆ ResourceMappingFileNameNotFoundErrorMessage

constexpr const char AWSCore::AWSCoreConfiguration::ResourceMappingFileNameNotFoundErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to get resource mapping config file name, return empty value instead."

◆ SettingsRegistryFileLoadFailureErrorMessage

constexpr const char AWSCore::AWSCoreConfiguration::SettingsRegistryFileLoadFailureErrorMessage[]
staticconstexpr
Initial value:
=
"Failed to load AWSCore settings registry file."

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