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

#include <Credentials.h>

Public Member Functions

 Credentials ()
 
 Credentials (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Credentialsoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetAccessKeyId () const
 
bool AccessKeyIdHasBeenSet () const
 
void SetAccessKeyId (const Aws::String &value)
 
void SetAccessKeyId (Aws::String &&value)
 
void SetAccessKeyId (const char *value)
 
CredentialsWithAccessKeyId (const Aws::String &value)
 
CredentialsWithAccessKeyId (Aws::String &&value)
 
CredentialsWithAccessKeyId (const char *value)
 
const Aws::StringGetSecretAccessKey () const
 
bool SecretAccessKeyHasBeenSet () const
 
void SetSecretAccessKey (const Aws::String &value)
 
void SetSecretAccessKey (Aws::String &&value)
 
void SetSecretAccessKey (const char *value)
 
CredentialsWithSecretAccessKey (const Aws::String &value)
 
CredentialsWithSecretAccessKey (Aws::String &&value)
 
CredentialsWithSecretAccessKey (const char *value)
 
const Aws::StringGetSessionToken () const
 
bool SessionTokenHasBeenSet () const
 
void SetSessionToken (const Aws::String &value)
 
void SetSessionToken (Aws::String &&value)
 
void SetSessionToken (const char *value)
 
CredentialsWithSessionToken (const Aws::String &value)
 
CredentialsWithSessionToken (Aws::String &&value)
 
CredentialsWithSessionToken (const char *value)
 
const Aws::Utils::DateTimeGetExpiration () const
 
bool ExpirationHasBeenSet () const
 
void SetExpiration (const Aws::Utils::DateTime &value)
 
void SetExpiration (Aws::Utils::DateTime &&value)
 
CredentialsWithExpiration (const Aws::Utils::DateTime &value)
 
CredentialsWithExpiration (Aws::Utils::DateTime &&value)
 

Detailed Description

Amazon Web Services credentials for API authentication.

See Also:

AWS API Reference

Definition at line 33 of file Credentials.h.

Constructor & Destructor Documentation

◆ Credentials() [1/2]

Aws::STS::Model::Credentials::Credentials ( )

◆ Credentials() [2/2]

Aws::STS::Model::Credentials::Credentials ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AccessKeyIdHasBeenSet()

bool Aws::STS::Model::Credentials::AccessKeyIdHasBeenSet ( ) const
inline

The access key ID that identifies the temporary security credentials.

Definition at line 52 of file Credentials.h.

◆ ExpirationHasBeenSet()

bool Aws::STS::Model::Credentials::ExpirationHasBeenSet ( ) const
inline

The date on which the current credentials expire.

Definition at line 183 of file Credentials.h.

◆ GetAccessKeyId()

const Aws::String& Aws::STS::Model::Credentials::GetAccessKeyId ( ) const
inline

The access key ID that identifies the temporary security credentials.

Definition at line 47 of file Credentials.h.

◆ GetExpiration()

const Aws::Utils::DateTime& Aws::STS::Model::Credentials::GetExpiration ( ) const
inline

The date on which the current credentials expire.

Definition at line 178 of file Credentials.h.

◆ GetSecretAccessKey()

const Aws::String& Aws::STS::Model::Credentials::GetSecretAccessKey ( ) const
inline

The secret access key that can be used to sign requests.

Definition at line 88 of file Credentials.h.

◆ GetSessionToken()

const Aws::String& Aws::STS::Model::Credentials::GetSessionToken ( ) const
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 130 of file Credentials.h.

◆ operator=()

Credentials& Aws::STS::Model::Credentials::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::STS::Model::Credentials::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::STS::Model::Credentials::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SecretAccessKeyHasBeenSet()

bool Aws::STS::Model::Credentials::SecretAccessKeyHasBeenSet ( ) const
inline

The secret access key that can be used to sign requests.

Definition at line 93 of file Credentials.h.

◆ SessionTokenHasBeenSet()

bool Aws::STS::Model::Credentials::SessionTokenHasBeenSet ( ) const
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 136 of file Credentials.h.

◆ SetAccessKeyId() [1/3]

void Aws::STS::Model::Credentials::SetAccessKeyId ( Aws::String &&  value)
inline

The access key ID that identifies the temporary security credentials.

Definition at line 62 of file Credentials.h.

◆ SetAccessKeyId() [2/3]

void Aws::STS::Model::Credentials::SetAccessKeyId ( const Aws::String value)
inline

The access key ID that identifies the temporary security credentials.

Definition at line 57 of file Credentials.h.

◆ SetAccessKeyId() [3/3]

void Aws::STS::Model::Credentials::SetAccessKeyId ( const char *  value)
inline

The access key ID that identifies the temporary security credentials.

Definition at line 67 of file Credentials.h.

◆ SetExpiration() [1/2]

void Aws::STS::Model::Credentials::SetExpiration ( Aws::Utils::DateTime &&  value)
inline

The date on which the current credentials expire.

Definition at line 193 of file Credentials.h.

◆ SetExpiration() [2/2]

void Aws::STS::Model::Credentials::SetExpiration ( const Aws::Utils::DateTime value)
inline

The date on which the current credentials expire.

Definition at line 188 of file Credentials.h.

◆ SetSecretAccessKey() [1/3]

void Aws::STS::Model::Credentials::SetSecretAccessKey ( Aws::String &&  value)
inline

The secret access key that can be used to sign requests.

Definition at line 103 of file Credentials.h.

◆ SetSecretAccessKey() [2/3]

void Aws::STS::Model::Credentials::SetSecretAccessKey ( const Aws::String value)
inline

The secret access key that can be used to sign requests.

Definition at line 98 of file Credentials.h.

◆ SetSecretAccessKey() [3/3]

void Aws::STS::Model::Credentials::SetSecretAccessKey ( const char *  value)
inline

The secret access key that can be used to sign requests.

Definition at line 108 of file Credentials.h.

◆ SetSessionToken() [1/3]

void Aws::STS::Model::Credentials::SetSessionToken ( Aws::String &&  value)
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 148 of file Credentials.h.

◆ SetSessionToken() [2/3]

void Aws::STS::Model::Credentials::SetSessionToken ( const Aws::String value)
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 142 of file Credentials.h.

◆ SetSessionToken() [3/3]

void Aws::STS::Model::Credentials::SetSessionToken ( const char *  value)
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 154 of file Credentials.h.

◆ WithAccessKeyId() [1/3]

Credentials& Aws::STS::Model::Credentials::WithAccessKeyId ( Aws::String &&  value)
inline

The access key ID that identifies the temporary security credentials.

Definition at line 77 of file Credentials.h.

◆ WithAccessKeyId() [2/3]

Credentials& Aws::STS::Model::Credentials::WithAccessKeyId ( const Aws::String value)
inline

The access key ID that identifies the temporary security credentials.

Definition at line 72 of file Credentials.h.

◆ WithAccessKeyId() [3/3]

Credentials& Aws::STS::Model::Credentials::WithAccessKeyId ( const char *  value)
inline

The access key ID that identifies the temporary security credentials.

Definition at line 82 of file Credentials.h.

◆ WithExpiration() [1/2]

Credentials& Aws::STS::Model::Credentials::WithExpiration ( Aws::Utils::DateTime &&  value)
inline

The date on which the current credentials expire.

Definition at line 203 of file Credentials.h.

◆ WithExpiration() [2/2]

Credentials& Aws::STS::Model::Credentials::WithExpiration ( const Aws::Utils::DateTime value)
inline

The date on which the current credentials expire.

Definition at line 198 of file Credentials.h.

◆ WithSecretAccessKey() [1/3]

Credentials& Aws::STS::Model::Credentials::WithSecretAccessKey ( Aws::String &&  value)
inline

The secret access key that can be used to sign requests.

Definition at line 118 of file Credentials.h.

◆ WithSecretAccessKey() [2/3]

Credentials& Aws::STS::Model::Credentials::WithSecretAccessKey ( const Aws::String value)
inline

The secret access key that can be used to sign requests.

Definition at line 113 of file Credentials.h.

◆ WithSecretAccessKey() [3/3]

Credentials& Aws::STS::Model::Credentials::WithSecretAccessKey ( const char *  value)
inline

The secret access key that can be used to sign requests.

Definition at line 123 of file Credentials.h.

◆ WithSessionToken() [1/3]

Credentials& Aws::STS::Model::Credentials::WithSessionToken ( Aws::String &&  value)
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 166 of file Credentials.h.

◆ WithSessionToken() [2/3]

Credentials& Aws::STS::Model::Credentials::WithSessionToken ( const Aws::String value)
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 160 of file Credentials.h.

◆ WithSessionToken() [3/3]

Credentials& Aws::STS::Model::Credentials::WithSessionToken ( const char *  value)
inline

The token that users must pass to the service API to use the temporary credentials.

Definition at line 172 of file Credentials.h.


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