AWS SDK for C++  1.8.26
AWS SDK for C++
Public Member Functions | List of all members
Aws::IAM::Model::AccessKey Class Reference

#include <AccessKey.h>

Public Member Functions

 AccessKey ()
 
 AccessKey (const Aws::Utils::Xml::XmlNode &xmlNode)
 
AccessKeyoperator= (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::StringGetUserName () const
 
bool UserNameHasBeenSet () const
 
void SetUserName (const Aws::String &value)
 
void SetUserName (Aws::String &&value)
 
void SetUserName (const char *value)
 
AccessKeyWithUserName (const Aws::String &value)
 
AccessKeyWithUserName (Aws::String &&value)
 
AccessKeyWithUserName (const char *value)
 
const Aws::StringGetAccessKeyId () const
 
bool AccessKeyIdHasBeenSet () const
 
void SetAccessKeyId (const Aws::String &value)
 
void SetAccessKeyId (Aws::String &&value)
 
void SetAccessKeyId (const char *value)
 
AccessKeyWithAccessKeyId (const Aws::String &value)
 
AccessKeyWithAccessKeyId (Aws::String &&value)
 
AccessKeyWithAccessKeyId (const char *value)
 
const StatusTypeGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const StatusType &value)
 
void SetStatus (StatusType &&value)
 
AccessKeyWithStatus (const StatusType &value)
 
AccessKeyWithStatus (StatusType &&value)
 
const Aws::StringGetSecretAccessKey () const
 
bool SecretAccessKeyHasBeenSet () const
 
void SetSecretAccessKey (const Aws::String &value)
 
void SetSecretAccessKey (Aws::String &&value)
 
void SetSecretAccessKey (const char *value)
 
AccessKeyWithSecretAccessKey (const Aws::String &value)
 
AccessKeyWithSecretAccessKey (Aws::String &&value)
 
AccessKeyWithSecretAccessKey (const char *value)
 
const Aws::Utils::DateTimeGetCreateDate () const
 
bool CreateDateHasBeenSet () const
 
void SetCreateDate (const Aws::Utils::DateTime &value)
 
void SetCreateDate (Aws::Utils::DateTime &&value)
 
AccessKeyWithCreateDate (const Aws::Utils::DateTime &value)
 
AccessKeyWithCreateDate (Aws::Utils::DateTime &&value)
 

Detailed Description

Contains information about an AWS access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

See Also:

AWS API Reference

Definition at line 39 of file AccessKey.h.

Constructor & Destructor Documentation

◆ AccessKey() [1/2]

Aws::IAM::Model::AccessKey::AccessKey ( )

◆ AccessKey() [2/2]

Aws::IAM::Model::AccessKey::AccessKey ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AccessKeyIdHasBeenSet()

bool Aws::IAM::Model::AccessKey::AccessKeyIdHasBeenSet ( ) const
inline

The ID for this access key.

Definition at line 99 of file AccessKey.h.

◆ CreateDateHasBeenSet()

bool Aws::IAM::Model::AccessKey::CreateDateHasBeenSet ( ) const
inline

The date when the access key was created.

Definition at line 218 of file AccessKey.h.

◆ GetAccessKeyId()

const Aws::String& Aws::IAM::Model::AccessKey::GetAccessKeyId ( ) const
inline

The ID for this access key.

Definition at line 94 of file AccessKey.h.

◆ GetCreateDate()

const Aws::Utils::DateTime& Aws::IAM::Model::AccessKey::GetCreateDate ( ) const
inline

The date when the access key was created.

Definition at line 213 of file AccessKey.h.

◆ GetSecretAccessKey()

const Aws::String& Aws::IAM::Model::AccessKey::GetSecretAccessKey ( ) const
inline

The secret key used to sign requests.

Definition at line 172 of file AccessKey.h.

◆ GetStatus()

const StatusType& Aws::IAM::Model::AccessKey::GetStatus ( ) const
inline

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

Definition at line 136 of file AccessKey.h.

◆ GetUserName()

const Aws::String& Aws::IAM::Model::AccessKey::GetUserName ( ) const
inline

The name of the IAM user that the access key is associated with.

Definition at line 53 of file AccessKey.h.

◆ operator=()

AccessKey& Aws::IAM::Model::AccessKey::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

void Aws::IAM::Model::AccessKey::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SecretAccessKeyHasBeenSet()

bool Aws::IAM::Model::AccessKey::SecretAccessKeyHasBeenSet ( ) const
inline

The secret key used to sign requests.

Definition at line 177 of file AccessKey.h.

◆ SetAccessKeyId() [1/3]

void Aws::IAM::Model::AccessKey::SetAccessKeyId ( const Aws::String value)
inline

The ID for this access key.

Definition at line 104 of file AccessKey.h.

◆ SetAccessKeyId() [2/3]

void Aws::IAM::Model::AccessKey::SetAccessKeyId ( Aws::String &&  value)
inline

The ID for this access key.

Definition at line 109 of file AccessKey.h.

◆ SetAccessKeyId() [3/3]

void Aws::IAM::Model::AccessKey::SetAccessKeyId ( const char *  value)
inline

The ID for this access key.

Definition at line 114 of file AccessKey.h.

◆ SetCreateDate() [1/2]

void Aws::IAM::Model::AccessKey::SetCreateDate ( const Aws::Utils::DateTime value)
inline

The date when the access key was created.

Definition at line 223 of file AccessKey.h.

◆ SetCreateDate() [2/2]

void Aws::IAM::Model::AccessKey::SetCreateDate ( Aws::Utils::DateTime &&  value)
inline

The date when the access key was created.

Definition at line 228 of file AccessKey.h.

◆ SetSecretAccessKey() [1/3]

void Aws::IAM::Model::AccessKey::SetSecretAccessKey ( const Aws::String value)
inline

The secret key used to sign requests.

Definition at line 182 of file AccessKey.h.

◆ SetSecretAccessKey() [2/3]

void Aws::IAM::Model::AccessKey::SetSecretAccessKey ( Aws::String &&  value)
inline

The secret key used to sign requests.

Definition at line 187 of file AccessKey.h.

◆ SetSecretAccessKey() [3/3]

void Aws::IAM::Model::AccessKey::SetSecretAccessKey ( const char *  value)
inline

The secret key used to sign requests.

Definition at line 192 of file AccessKey.h.

◆ SetStatus() [1/2]

void Aws::IAM::Model::AccessKey::SetStatus ( const StatusType value)
inline

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

Definition at line 148 of file AccessKey.h.

◆ SetStatus() [2/2]

void Aws::IAM::Model::AccessKey::SetStatus ( StatusType &&  value)
inline

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

Definition at line 154 of file AccessKey.h.

◆ SetUserName() [1/3]

void Aws::IAM::Model::AccessKey::SetUserName ( const Aws::String value)
inline

The name of the IAM user that the access key is associated with.

Definition at line 63 of file AccessKey.h.

◆ SetUserName() [2/3]

void Aws::IAM::Model::AccessKey::SetUserName ( Aws::String &&  value)
inline

The name of the IAM user that the access key is associated with.

Definition at line 68 of file AccessKey.h.

◆ SetUserName() [3/3]

void Aws::IAM::Model::AccessKey::SetUserName ( const char *  value)
inline

The name of the IAM user that the access key is associated with.

Definition at line 73 of file AccessKey.h.

◆ StatusHasBeenSet()

bool Aws::IAM::Model::AccessKey::StatusHasBeenSet ( ) const
inline

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

Definition at line 142 of file AccessKey.h.

◆ UserNameHasBeenSet()

bool Aws::IAM::Model::AccessKey::UserNameHasBeenSet ( ) const
inline

The name of the IAM user that the access key is associated with.

Definition at line 58 of file AccessKey.h.

◆ WithAccessKeyId() [1/3]

AccessKey& Aws::IAM::Model::AccessKey::WithAccessKeyId ( const Aws::String value)
inline

The ID for this access key.

Definition at line 119 of file AccessKey.h.

◆ WithAccessKeyId() [2/3]

AccessKey& Aws::IAM::Model::AccessKey::WithAccessKeyId ( Aws::String &&  value)
inline

The ID for this access key.

Definition at line 124 of file AccessKey.h.

◆ WithAccessKeyId() [3/3]

AccessKey& Aws::IAM::Model::AccessKey::WithAccessKeyId ( const char *  value)
inline

The ID for this access key.

Definition at line 129 of file AccessKey.h.

◆ WithCreateDate() [1/2]

AccessKey& Aws::IAM::Model::AccessKey::WithCreateDate ( const Aws::Utils::DateTime value)
inline

The date when the access key was created.

Definition at line 233 of file AccessKey.h.

◆ WithCreateDate() [2/2]

AccessKey& Aws::IAM::Model::AccessKey::WithCreateDate ( Aws::Utils::DateTime &&  value)
inline

The date when the access key was created.

Definition at line 238 of file AccessKey.h.

◆ WithSecretAccessKey() [1/3]

AccessKey& Aws::IAM::Model::AccessKey::WithSecretAccessKey ( const Aws::String value)
inline

The secret key used to sign requests.

Definition at line 197 of file AccessKey.h.

◆ WithSecretAccessKey() [2/3]

AccessKey& Aws::IAM::Model::AccessKey::WithSecretAccessKey ( Aws::String &&  value)
inline

The secret key used to sign requests.

Definition at line 202 of file AccessKey.h.

◆ WithSecretAccessKey() [3/3]

AccessKey& Aws::IAM::Model::AccessKey::WithSecretAccessKey ( const char *  value)
inline

The secret key used to sign requests.

Definition at line 207 of file AccessKey.h.

◆ WithStatus() [1/2]

AccessKey& Aws::IAM::Model::AccessKey::WithStatus ( const StatusType value)
inline

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

Definition at line 160 of file AccessKey.h.

◆ WithStatus() [2/2]

AccessKey& Aws::IAM::Model::AccessKey::WithStatus ( StatusType &&  value)
inline

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

Definition at line 166 of file AccessKey.h.

◆ WithUserName() [1/3]

AccessKey& Aws::IAM::Model::AccessKey::WithUserName ( const Aws::String value)
inline

The name of the IAM user that the access key is associated with.

Definition at line 78 of file AccessKey.h.

◆ WithUserName() [2/3]

AccessKey& Aws::IAM::Model::AccessKey::WithUserName ( Aws::String &&  value)
inline

The name of the IAM user that the access key is associated with.

Definition at line 83 of file AccessKey.h.

◆ WithUserName() [3/3]

AccessKey& Aws::IAM::Model::AccessKey::WithUserName ( const char *  value)
inline

The name of the IAM user that the access key is associated with.

Definition at line 88 of file AccessKey.h.


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