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

#include <AWSCredentials.h>

Public Member Functions

 AWSCredentials ()
 
 AWSCredentials (const Aws::String &accessKeyId, const Aws::String &secretKey, const Aws::String &sessionToken="")
 
bool operator== (const AWSCredentials &other) const
 
bool operator!= (const AWSCredentials &other) const
 
bool IsEmpty () const
 
const Aws::StringGetAWSAccessKeyId () const
 
const Aws::StringGetAWSSecretKey () const
 
const Aws::StringGetSessionToken () const
 
void SetAWSAccessKeyId (const Aws::String &accessKeyId)
 
void SetAWSSecretKey (const Aws::String &secretKey)
 
void SetSessionToken (const Aws::String &sessionToken)
 
void SetAWSAccessKeyId (const char *accessKeyId)
 
void SetAWSSecretKey (const char *secretKey)
 
void SetSessionToken (const char *sessionToken)
 

Detailed Description

Simple data object around aws credentials

Definition at line 27 of file AWSCredentials.h.

Constructor & Destructor Documentation

◆ AWSCredentials() [1/2]

Aws::Auth::AWSCredentials::AWSCredentials ( )
inline

Definition at line 30 of file AWSCredentials.h.

◆ AWSCredentials() [2/2]

Aws::Auth::AWSCredentials::AWSCredentials ( const Aws::String accessKeyId,
const Aws::String secretKey,
const Aws::String sessionToken = "" 
)
inline

Initializes object with accessKeyId, secretKey, and sessionToken. Session token defaults to empty.

Definition at line 35 of file AWSCredentials.h.

Member Function Documentation

◆ GetAWSAccessKeyId()

const Aws::String& Aws::Auth::AWSCredentials::GetAWSAccessKeyId ( ) const
inline

Gets the underlying access key credential

Definition at line 51 of file AWSCredentials.h.

◆ GetAWSSecretKey()

const Aws::String& Aws::Auth::AWSCredentials::GetAWSSecretKey ( ) const
inline

Gets the underlying secret key credential

Definition at line 59 of file AWSCredentials.h.

◆ GetSessionToken()

const Aws::String& Aws::Auth::AWSCredentials::GetSessionToken ( ) const
inline

Gets the underlying session token

Definition at line 67 of file AWSCredentials.h.

◆ IsEmpty()

bool Aws::Auth::AWSCredentials::IsEmpty ( ) const
inline

If credentials haven't been initialized or been initialized to emtpy values.

Definition at line 46 of file AWSCredentials.h.

◆ operator!=()

bool Aws::Auth::AWSCredentials::operator!= ( const AWSCredentials other) const
inline

Definition at line 41 of file AWSCredentials.h.

◆ operator==()

bool Aws::Auth::AWSCredentials::operator== ( const AWSCredentials other) const
inline

Definition at line 40 of file AWSCredentials.h.

◆ SetAWSAccessKeyId() [1/2]

void Aws::Auth::AWSCredentials::SetAWSAccessKeyId ( const Aws::String accessKeyId)
inline

Sets the underlying access key credential. Copies from parameter accessKeyId.

Definition at line 75 of file AWSCredentials.h.

◆ SetAWSAccessKeyId() [2/2]

void Aws::Auth::AWSCredentials::SetAWSAccessKeyId ( const char *  accessKeyId)
inline

Sets the underlying access key credential. Copies from parameter accessKeyId.

Definition at line 99 of file AWSCredentials.h.

◆ SetAWSSecretKey() [1/2]

void Aws::Auth::AWSCredentials::SetAWSSecretKey ( const Aws::String secretKey)
inline

Sets the underlying secret key credential. Copies from parameter secretKey

Definition at line 83 of file AWSCredentials.h.

◆ SetAWSSecretKey() [2/2]

void Aws::Auth::AWSCredentials::SetAWSSecretKey ( const char *  secretKey)
inline

Sets the underlying secret key credential. Copies from parameter secretKey

Definition at line 107 of file AWSCredentials.h.

◆ SetSessionToken() [1/2]

void Aws::Auth::AWSCredentials::SetSessionToken ( const Aws::String sessionToken)
inline

Sets the underlyint session token. Copies from parameter sessionToken

Definition at line 91 of file AWSCredentials.h.

◆ SetSessionToken() [2/2]

void Aws::Auth::AWSCredentials::SetSessionToken ( const char *  sessionToken)
inline

Sets the underlying secret key credential. Copies from parameter secretKey

Definition at line 115 of file AWSCredentials.h.


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