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

#include <CognitoCachingCredentialsProvider.h>

+ Inheritance diagram for Aws::Auth::CognitoCachingCredentialsProvider:

Public Member Functions

AWSCredentials GetAWSCredentials () override
 
- Public Member Functions inherited from Aws::Auth::AWSCredentialsProvider
 AWSCredentialsProvider ()
 
virtual ~AWSCredentialsProvider ()=default
 

Protected Member Functions

 CognitoCachingCredentialsProvider (const std::shared_ptr< PersistentCognitoIdentityProvider > &m_identityRepository, const std::shared_ptr< CognitoIdentity::CognitoIdentityClient > &cognitoIdentityClient=nullptr)
 
virtual CognitoIdentity::Model::GetCredentialsForIdentityOutcome GetCredentialsFromCognito () const =0
 
bool IsTimeExpired (double expiry)
 
- Protected Member Functions inherited from Aws::Auth::AWSCredentialsProvider
virtual bool IsTimeToRefresh (long reloadFrequency)
 
virtual void Reload ()
 

Protected Attributes

std::shared_ptr< CognitoIdentity::CognitoIdentityClientm_cognitoIdentityClient
 
std::shared_ptr< PersistentCognitoIdentityProviderm_identityRepository
 
- Protected Attributes inherited from Aws::Auth::AWSCredentialsProvider
Aws::Utils::Threading::ReaderWriterLock m_reloadLock
 

Detailed Description

Credentials provider that can be used to authenticate a user with any other AWS service. This credentials provider can be passed to any other Aws Client.

Definition at line 24 of file CognitoCachingCredentialsProvider.h.

Constructor & Destructor Documentation

◆ CognitoCachingCredentialsProvider()

Aws::Auth::CognitoCachingCredentialsProvider::CognitoCachingCredentialsProvider ( const std::shared_ptr< PersistentCognitoIdentityProvider > &  m_identityRepository,
const std::shared_ptr< CognitoIdentity::CognitoIdentityClient > &  cognitoIdentityClient = nullptr 
)
protected

PersistentCognitoIdentityProvider is responsible for storing and retrieving cognito identity information from memory or file system.

Member Function Documentation

◆ GetAWSCredentials()

AWSCredentials Aws::Auth::CognitoCachingCredentialsProvider::GetAWSCredentials ( )
overridevirtual

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

Implements Aws::Auth::AWSCredentialsProvider.

◆ GetCredentialsFromCognito()

virtual CognitoIdentity::Model::GetCredentialsForIdentityOutcome Aws::Auth::CognitoCachingCredentialsProvider::GetCredentialsFromCognito ( ) const
protectedpure virtual

◆ IsTimeExpired()

bool Aws::Auth::CognitoCachingCredentialsProvider::IsTimeExpired ( double  expiry)
protected

Member Data Documentation

◆ m_cognitoIdentityClient

std::shared_ptr<CognitoIdentity::CognitoIdentityClient> Aws::Auth::CognitoCachingCredentialsProvider::m_cognitoIdentityClient
protected

Definition at line 41 of file CognitoCachingCredentialsProvider.h.

◆ m_identityRepository

std::shared_ptr<PersistentCognitoIdentityProvider> Aws::Auth::CognitoCachingCredentialsProvider::m_identityRepository
protected

Definition at line 42 of file CognitoCachingCredentialsProvider.h.


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