Aws::Auth::AWSBearerToken Class Reference

#include <AWSBearerToken.h>

Public Member Functions

 AWSBearerToken ()

 

 AWSBearerToken (const Aws::String &token)

 

 AWSBearerToken (const Aws::String &token, Aws::Utils::DateTime expiration)

 

bool IsEmpty () const

 

bool IsExpired () const

 

bool IsExpiredOrEmpty () const

 

const Aws::String & GetToken () const

 

Aws::Utils::DateTime GetExpiration () const

 

void SetToken (const Aws::String &token)

 

void SetToken (Aws::String &&token)

 

void SetExpiration (const Aws::Utils::DateTime &expiration)

 

void SetExpiration (Aws::Utils::DateTime &&expiration)

 

Detailed Description

Simple data object around aws credentials

Definition at line 19 of file AWSBearerToken.h.

Constructor & Destructor Documentation

AWSBearerToken() [1/3]

Aws::Auth::AWSBearerToken::AWSBearerToken ( )

inline

Initializes an empty token. Empty token is not expired by default. Token expires only if an expiration date is explicitly set.

Definition at line 27 of file AWSBearerToken.h.

AWSBearerToken() [2/3]

Aws::Auth::AWSBearerToken::AWSBearerToken ( const Aws::String &  token)

inline

Initializes object with token. Expiration date is set to "never expire".

Definition at line 35 of file AWSBearerToken.h.

AWSBearerToken() [3/3]

Aws::Auth::AWSBearerToken::AWSBearerToken ( const Aws::String &  token,

Aws::Utils::DateTime  expiration 

)

inline

Initializes object with token and expiration date.

Definition at line 44 of file AWSBearerToken.h.

Member Function Documentation

GetExpiration()

Aws::Utils::DateTime Aws::Auth::AWSBearerToken::GetExpiration ( ) const

inline

Gets the expiration date of the token

Definition at line 71 of file AWSBearerToken.h.

GetToken()

const Aws::String & Aws::Auth::AWSBearerToken::GetToken ( ) const

inline

Gets the underlying token

Definition at line 63 of file AWSBearerToken.h.

IsEmpty()

bool Aws::Auth::AWSBearerToken::IsEmpty ( ) const

inline

If token has not been initialized or been initialized to empty value. Expiration date does not affect the result of this function.

Definition at line 54 of file AWSBearerToken.h.

IsExpired()

bool Aws::Auth::AWSBearerToken::IsExpired ( ) const

inline

Definition at line 56 of file AWSBearerToken.h.

IsExpiredOrEmpty()

bool Aws::Auth::AWSBearerToken::IsExpiredOrEmpty ( ) const

inline

Definition at line 58 of file AWSBearerToken.h.

SetExpiration() [1/2]

void Aws::Auth::AWSBearerToken::SetExpiration ( Aws::Utils::DateTime &&  expiration)

inline

Sets the expiration date of the credential

Definition at line 103 of file AWSBearerToken.h.

SetExpiration() [2/2]

void Aws::Auth::AWSBearerToken::SetExpiration ( const Aws::Utils::DateTime &  expiration)

inline

Sets the expiration date of the credential

Definition at line 95 of file AWSBearerToken.h.

SetToken() [1/2]

void Aws::Auth::AWSBearerToken::SetToken ( Aws::String &&  token)

inline

Sets the underlying token. Moves from the parameter token

Definition at line 87 of file AWSBearerToken.h.

SetToken() [2/2]

void Aws::Auth::AWSBearerToken::SetToken ( const Aws::String &  token)

inline

Sets the underlying token. Copies from the parameter token

Definition at line 79 of file AWSBearerToken.h.

---

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

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