AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Connect::Model::Credentials Class Reference

#include <Credentials.h>

Public Member Functions

 Credentials ()
 
 Credentials (Aws::Utils::Json::JsonView jsonValue)
 
Credentialsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAccessToken () const
 
bool AccessTokenHasBeenSet () const
 
void SetAccessToken (const Aws::String &value)
 
void SetAccessToken (Aws::String &&value)
 
void SetAccessToken (const char *value)
 
CredentialsWithAccessToken (const Aws::String &value)
 
CredentialsWithAccessToken (Aws::String &&value)
 
CredentialsWithAccessToken (const char *value)
 
const Aws::Utils::DateTimeGetAccessTokenExpiration () const
 
bool AccessTokenExpirationHasBeenSet () const
 
void SetAccessTokenExpiration (const Aws::Utils::DateTime &value)
 
void SetAccessTokenExpiration (Aws::Utils::DateTime &&value)
 
CredentialsWithAccessTokenExpiration (const Aws::Utils::DateTime &value)
 
CredentialsWithAccessTokenExpiration (Aws::Utils::DateTime &&value)
 
const Aws::StringGetRefreshToken () const
 
bool RefreshTokenHasBeenSet () const
 
void SetRefreshToken (const Aws::String &value)
 
void SetRefreshToken (Aws::String &&value)
 
void SetRefreshToken (const char *value)
 
CredentialsWithRefreshToken (const Aws::String &value)
 
CredentialsWithRefreshToken (Aws::String &&value)
 
CredentialsWithRefreshToken (const char *value)
 
const Aws::Utils::DateTimeGetRefreshTokenExpiration () const
 
bool RefreshTokenExpirationHasBeenSet () const
 
void SetRefreshTokenExpiration (const Aws::Utils::DateTime &value)
 
void SetRefreshTokenExpiration (Aws::Utils::DateTime &&value)
 
CredentialsWithRefreshTokenExpiration (const Aws::Utils::DateTime &value)
 
CredentialsWithRefreshTokenExpiration (Aws::Utils::DateTime &&value)
 

Detailed Description

Contains credentials to use for federation.

See Also:

AWS API Reference

Definition at line 32 of file Credentials.h.

Constructor & Destructor Documentation

◆ Credentials() [1/2]

Aws::Connect::Model::Credentials::Credentials ( )

◆ Credentials() [2/2]

Aws::Connect::Model::Credentials::Credentials ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccessTokenExpirationHasBeenSet()

bool Aws::Connect::Model::Credentials::AccessTokenExpirationHasBeenSet ( ) const
inline

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Definition at line 92 of file Credentials.h.

◆ AccessTokenHasBeenSet()

bool Aws::Connect::Model::Credentials::AccessTokenHasBeenSet ( ) const
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 49 of file Credentials.h.

◆ GetAccessToken()

const Aws::String& Aws::Connect::Model::Credentials::GetAccessToken ( ) const
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 44 of file Credentials.h.

◆ GetAccessTokenExpiration()

const Aws::Utils::DateTime& Aws::Connect::Model::Credentials::GetAccessTokenExpiration ( ) const
inline

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Definition at line 86 of file Credentials.h.

◆ GetRefreshToken()

const Aws::String& Aws::Connect::Model::Credentials::GetRefreshToken ( ) const
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 123 of file Credentials.h.

◆ GetRefreshTokenExpiration()

const Aws::Utils::DateTime& Aws::Connect::Model::Credentials::GetRefreshTokenExpiration ( ) const
inline

Renews the expiration timer for a generated token.

Definition at line 171 of file Credentials.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Connect::Model::Credentials::Jsonize ( ) const

◆ operator=()

Credentials& Aws::Connect::Model::Credentials::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RefreshTokenExpirationHasBeenSet()

bool Aws::Connect::Model::Credentials::RefreshTokenExpirationHasBeenSet ( ) const
inline

Renews the expiration timer for a generated token.

Definition at line 176 of file Credentials.h.

◆ RefreshTokenHasBeenSet()

bool Aws::Connect::Model::Credentials::RefreshTokenHasBeenSet ( ) const
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 129 of file Credentials.h.

◆ SetAccessToken() [1/3]

void Aws::Connect::Model::Credentials::SetAccessToken ( const Aws::String value)
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 54 of file Credentials.h.

◆ SetAccessToken() [2/3]

void Aws::Connect::Model::Credentials::SetAccessToken ( Aws::String &&  value)
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 59 of file Credentials.h.

◆ SetAccessToken() [3/3]

void Aws::Connect::Model::Credentials::SetAccessToken ( const char *  value)
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 64 of file Credentials.h.

◆ SetAccessTokenExpiration() [1/2]

void Aws::Connect::Model::Credentials::SetAccessTokenExpiration ( const Aws::Utils::DateTime value)
inline

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Definition at line 98 of file Credentials.h.

◆ SetAccessTokenExpiration() [2/2]

void Aws::Connect::Model::Credentials::SetAccessTokenExpiration ( Aws::Utils::DateTime &&  value)
inline

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Definition at line 104 of file Credentials.h.

◆ SetRefreshToken() [1/3]

void Aws::Connect::Model::Credentials::SetRefreshToken ( const Aws::String value)
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 135 of file Credentials.h.

◆ SetRefreshToken() [2/3]

void Aws::Connect::Model::Credentials::SetRefreshToken ( Aws::String &&  value)
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 141 of file Credentials.h.

◆ SetRefreshToken() [3/3]

void Aws::Connect::Model::Credentials::SetRefreshToken ( const char *  value)
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 147 of file Credentials.h.

◆ SetRefreshTokenExpiration() [1/2]

void Aws::Connect::Model::Credentials::SetRefreshTokenExpiration ( const Aws::Utils::DateTime value)
inline

Renews the expiration timer for a generated token.

Definition at line 181 of file Credentials.h.

◆ SetRefreshTokenExpiration() [2/2]

void Aws::Connect::Model::Credentials::SetRefreshTokenExpiration ( Aws::Utils::DateTime &&  value)
inline

Renews the expiration timer for a generated token.

Definition at line 186 of file Credentials.h.

◆ WithAccessToken() [1/3]

Credentials& Aws::Connect::Model::Credentials::WithAccessToken ( const Aws::String value)
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 69 of file Credentials.h.

◆ WithAccessToken() [2/3]

Credentials& Aws::Connect::Model::Credentials::WithAccessToken ( Aws::String &&  value)
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 74 of file Credentials.h.

◆ WithAccessToken() [3/3]

Credentials& Aws::Connect::Model::Credentials::WithAccessToken ( const char *  value)
inline

An access token generated for a federated user to access Amazon Connect.

Definition at line 79 of file Credentials.h.

◆ WithAccessTokenExpiration() [1/2]

Credentials& Aws::Connect::Model::Credentials::WithAccessTokenExpiration ( const Aws::Utils::DateTime value)
inline

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Definition at line 110 of file Credentials.h.

◆ WithAccessTokenExpiration() [2/2]

Credentials& Aws::Connect::Model::Credentials::WithAccessTokenExpiration ( Aws::Utils::DateTime &&  value)
inline

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Definition at line 116 of file Credentials.h.

◆ WithRefreshToken() [1/3]

Credentials& Aws::Connect::Model::Credentials::WithRefreshToken ( const Aws::String value)
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 153 of file Credentials.h.

◆ WithRefreshToken() [2/3]

Credentials& Aws::Connect::Model::Credentials::WithRefreshToken ( Aws::String &&  value)
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 159 of file Credentials.h.

◆ WithRefreshToken() [3/3]

Credentials& Aws::Connect::Model::Credentials::WithRefreshToken ( const char *  value)
inline

Renews a token generated for a user to access the Amazon Connect instance.

Definition at line 165 of file Credentials.h.

◆ WithRefreshTokenExpiration() [1/2]

Credentials& Aws::Connect::Model::Credentials::WithRefreshTokenExpiration ( const Aws::Utils::DateTime value)
inline

Renews the expiration timer for a generated token.

Definition at line 191 of file Credentials.h.

◆ WithRefreshTokenExpiration() [2/2]

Credentials& Aws::Connect::Model::Credentials::WithRefreshTokenExpiration ( Aws::Utils::DateTime &&  value)
inline

Renews the expiration timer for a generated token.

Definition at line 196 of file Credentials.h.


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