Aws::Auth::ProfileCredentialsProvider Class Reference

#include <ProfileCredentialsProvider.h>

Inheritance diagram for Aws::Auth::ProfileCredentialsProvider:

Public Member Functions

 ProfileCredentialsProvider (long refreshRateMs=REFRESH_THRESHOLD)

 

 ProfileCredentialsProvider (const char *profile, long refreshRateMs=REFRESH_THRESHOLD)

 

AWSCredentials GetAWSCredentials () override

 

Public Member Functions inherited from Aws::Auth::AWSCredentialsProvider

 AWSCredentialsProvider ()

 

virtual ~AWSCredentialsProvider ()=default

 

Static Public Member Functions

static Aws::String GetCredentialsProfileFilename ()

 

static Aws::String GetProfileDirectory ()

 

Protected Member Functions

void Reload () override

 

Protected Member Functions inherited from Aws::Auth::AWSCredentialsProvider

virtual bool IsTimeToRefresh (long reloadFrequency)

 

Additional Inherited Members

Protected Attributes inherited from Aws::Auth::AWSCredentialsProvider

Aws::Utils::Threading::ReaderWriterLock m_reloadLock

 

Detailed Description

CRT-based credentials provider that sources credentials from config files with full SEP compliance. Supports assume role, credential_source, role chaining, and all SEP scenarios.

Definition at line 15 of file ProfileCredentialsProvider.h.

Constructor & Destructor Documentation

ProfileCredentialsProvider() [1/2]

Aws::Auth::ProfileCredentialsProvider::ProfileCredentialsProvider ( long  refreshRateMs = REFRESH_THRESHOLD)

Initializes with refreshRateMs as the frequency at which the file is reparsed in milliseconds. Defaults to 5 minutes.

ProfileCredentialsProvider() [2/2]

Aws::Auth::ProfileCredentialsProvider::ProfileCredentialsProvider ( const char *  profile,

long  refreshRateMs = REFRESH_THRESHOLD 

)

Initializes with a profile override and refreshRateMs as the frequency at which the file is reparsed in milliseconds. Defaults to 5 minutes.

Member Function Documentation

GetAWSCredentials()

AWSCredentials Aws::Auth::ProfileCredentialsProvider::GetAWSCredentials ( )

overridevirtual

Retrieves the credentials if found, otherwise returns empty credential set.

Implements Aws::Auth::AWSCredentialsProvider.

GetCredentialsProfileFilename()

static Aws::String Aws::Auth::ProfileCredentialsProvider::GetCredentialsProfileFilename ( )

static

Returns the fullpath of the calculated credentials profile file

GetProfileDirectory()

static Aws::String Aws::Auth::ProfileCredentialsProvider::GetProfileDirectory ( )

static

Returns the directory storing the profile file.

Reload()

void Aws::Auth::ProfileCredentialsProvider::Reload ( )

overrideprotectedvirtual

Reimplemented from Aws::Auth::AWSCredentialsProvider.

---

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

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