AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Aws::Auth::AWSCredentialsProvider Class Referenceabstract

#include <AWSCredentialsProvider.h>

+ Inheritance diagram for Aws::Auth::AWSCredentialsProvider:

Public Member Functions

 AWSCredentialsProvider ()
 
virtual ~AWSCredentialsProvider ()=default
 
virtual AWSCredentials GetAWSCredentials ()=0
 

Protected Member Functions

virtual bool IsTimeToRefresh (long reloadFrequency)
 
virtual void Reload ()
 

Protected Attributes

Aws::Utils::Threading::ReaderWriterLock m_reloadLock
 

Detailed Description

Abstract class for retrieving AWS credentials. Create a derived class from this to allow various methods of storing and retrieving credentials. Examples would be cognito-identity, some encrypted store etc...

Definition at line 50 of file AWSCredentialsProvider.h.

Constructor & Destructor Documentation

◆ AWSCredentialsProvider()

Aws::Auth::AWSCredentialsProvider::AWSCredentialsProvider ( )
inline

Initializes provider. Sets last Loaded time count to 0, forcing a refresh on the first call to GetAWSCredentials.

Definition at line 57 of file AWSCredentialsProvider.h.

◆ ~AWSCredentialsProvider()

virtual Aws::Auth::AWSCredentialsProvider::~AWSCredentialsProvider ( )
virtualdefault

Member Function Documentation

◆ GetAWSCredentials()

virtual AWSCredentials Aws::Auth::AWSCredentialsProvider::GetAWSCredentials ( )
pure virtual

◆ IsTimeToRefresh()

virtual bool Aws::Auth::AWSCredentialsProvider::IsTimeToRefresh ( long  reloadFrequency)
protectedvirtual

The default implementation keeps up with the cache times and lets you know if it's time to refresh your internal caching to aid your implementation of GetAWSCredentials.

◆ Reload()

virtual void Aws::Auth::AWSCredentialsProvider::Reload ( )
protectedvirtual

Member Data Documentation

◆ m_reloadLock

Aws::Utils::Threading::ReaderWriterLock Aws::Auth::AWSCredentialsProvider::m_reloadLock
mutableprotected

Definition at line 75 of file AWSCredentialsProvider.h.


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