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

#include <AWSCredentialsProvider.h>

+ Inheritance diagram for Aws::Auth::SimpleAWSCredentialsProvider:

Public Member Functions

 SimpleAWSCredentialsProvider (const Aws::String &awsAccessKeyId, const Aws::String &awsSecretAccessKey, const Aws::String &sessionToken="")
 
 SimpleAWSCredentialsProvider (const AWSCredentials &credentials)
 
AWSCredentials GetAWSCredentials () override
 
- Public Member Functions inherited from Aws::Auth::AWSCredentialsProvider
 AWSCredentialsProvider ()
 
virtual ~AWSCredentialsProvider ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Auth::AWSCredentialsProvider
virtual bool IsTimeToRefresh (long reloadFrequency)
 
virtual void Reload ()
 
- Protected Attributes inherited from Aws::Auth::AWSCredentialsProvider
Aws::Utils::Threading::ReaderWriterLock m_reloadLock
 

Detailed Description

A simple string provider. It takes the AccessKeyId and the SecretKey as constructor args and provides them through the interface. This is the default class for AWSClients that take string arguments for credentials.

Definition at line 98 of file AWSCredentialsProvider.h.

Constructor & Destructor Documentation

◆ SimpleAWSCredentialsProvider() [1/2]

Aws::Auth::SimpleAWSCredentialsProvider::SimpleAWSCredentialsProvider ( const Aws::String awsAccessKeyId,
const Aws::String awsSecretAccessKey,
const Aws::String sessionToken = "" 
)
inline

Initializes object from awsAccessKeyId, awsSecretAccessKey, and sessionToken parameters. sessionToken parameter is defaulted to empty.

Definition at line 104 of file AWSCredentialsProvider.h.

◆ SimpleAWSCredentialsProvider() [2/2]

Aws::Auth::SimpleAWSCredentialsProvider::SimpleAWSCredentialsProvider ( const AWSCredentials credentials)
inline

Initializes object from credentials object. everything is copied.

Definition at line 111 of file AWSCredentialsProvider.h.

Member Function Documentation

◆ GetAWSCredentials()

AWSCredentials Aws::Auth::SimpleAWSCredentialsProvider::GetAWSCredentials ( )
inlineoverridevirtual

Returns the credentials this object was initialized with as an AWSCredentials object.

Implements Aws::Auth::AWSCredentialsProvider.

Definition at line 118 of file AWSCredentialsProvider.h.


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