Aws::Auth::AWSCredentialsProvider Class Reference

#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 58 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 65 of file AWSCredentialsProvider.h.

~AWSCredentialsProvider()

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

virtualdefault

Member Function Documentation

GetAWSCredentials()

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

pure virtual

The core of the credential provider interface. Override this method to control how credentials are retrieved.

Implemented in Aws::Auth::AnonymousAWSCredentialsProvider, Aws::Auth::SimpleAWSCredentialsProvider, Aws::Auth::EnvironmentAWSCredentialsProvider, Aws::Auth::ProfileConfigFileAWSCredentialsProvider, Aws::Auth::InstanceProfileCredentialsProvider, Aws::Auth::ProcessCredentialsProvider, Aws::Auth::AWSCredentialsProviderChain, Aws::Auth::CrtCredentialsProvider, Aws::Auth::GeneralHTTPCredentialsProvider, Aws::Auth::ProfileCredentialsProvider, and Aws::Auth::SSOCredentialsProvider.

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

Reimplemented in Aws::Auth::ProfileConfigFileAWSCredentialsProvider, Aws::Auth::InstanceProfileCredentialsProvider, Aws::Auth::ProcessCredentialsProvider, Aws::Auth::GeneralHTTPCredentialsProvider, and Aws::Auth::ProfileCredentialsProvider.

Member Data Documentation

m_reloadLock

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

mutableprotected

Definition at line 83 of file AWSCredentialsProvider.h.

---

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

• src/aws-cpp-sdk-core/include/aws/core/auth/AWSCredentialsProvider.h