AWS SDK for C++  1.8.59
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::Auth::AWSCredentialsProviderChain Class Reference

#include <AWSCredentialsProviderChain.h>

+ Inheritance diagram for Aws::Auth::AWSCredentialsProviderChain:

Public Member Functions

virtual ~AWSCredentialsProviderChain ()=default
 
virtual AWSCredentials GetAWSCredentials ()
 
const Aws::Vector< std::shared_ptr< AWSCredentialsProvider > > & GetProviders ()
 
- Public Member Functions inherited from Aws::Auth::AWSCredentialsProvider
 AWSCredentialsProvider ()
 
virtual ~AWSCredentialsProvider ()=default
 

Protected Member Functions

 AWSCredentialsProviderChain ()=default
 
void AddProvider (const std::shared_ptr< AWSCredentialsProvider > &provider)
 
- Protected Member Functions inherited from Aws::Auth::AWSCredentialsProvider
virtual bool IsTimeToRefresh (long reloadFrequency)
 
virtual void Reload ()
 

Additional Inherited Members

- Protected Attributes inherited from Aws::Auth::AWSCredentialsProvider
Aws::Utils::Threading::ReaderWriterLock m_reloadLock
 

Detailed Description

Abstract class for providing chains of credentials providers. When a credentials provider in the chain returns empty credentials, We go on to the next provider until we have either exhausted the installed providers in the chain or something returns non-empty credentials.

Definition at line 21 of file AWSCredentialsProviderChain.h.

Constructor & Destructor Documentation

◆ ~AWSCredentialsProviderChain()

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

◆ AWSCredentialsProviderChain()

Aws::Auth::AWSCredentialsProviderChain::AWSCredentialsProviderChain ( )
protecteddefault

This class is only allowed to be initialized by subclasses.

Member Function Documentation

◆ AddProvider()

void Aws::Auth::AWSCredentialsProviderChain::AddProvider ( const std::shared_ptr< AWSCredentialsProvider > &  provider)
inlineprotected

Adds a provider to the back of the chain.

Definition at line 46 of file AWSCredentialsProviderChain.h.

◆ GetAWSCredentials()

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

When a credentials provider in the chain returns empty credentials, We go on to the next provider until we have either exhausted the installed providers in the chain or something returns non-empty credentials.

Implements Aws::Auth::AWSCredentialsProvider.

◆ GetProviders()

const Aws::Vector<std::shared_ptr<AWSCredentialsProvider> >& Aws::Auth::AWSCredentialsProviderChain::GetProviders ( )
inline

Gets all providers stored in this chain.

Definition at line 35 of file AWSCredentialsProviderChain.h.


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