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

#include <User.h>

Public Member Functions

 User ()
 
 User (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Useroperator= (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::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
UserWithPath (const Aws::String &value)
 
UserWithPath (Aws::String &&value)
 
UserWithPath (const char *value)
 
const Aws::StringGetUserName () const
 
bool UserNameHasBeenSet () const
 
void SetUserName (const Aws::String &value)
 
void SetUserName (Aws::String &&value)
 
void SetUserName (const char *value)
 
UserWithUserName (const Aws::String &value)
 
UserWithUserName (Aws::String &&value)
 
UserWithUserName (const char *value)
 
const Aws::StringGetUserId () const
 
bool UserIdHasBeenSet () const
 
void SetUserId (const Aws::String &value)
 
void SetUserId (Aws::String &&value)
 
void SetUserId (const char *value)
 
UserWithUserId (const Aws::String &value)
 
UserWithUserId (Aws::String &&value)
 
UserWithUserId (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
UserWithArn (const Aws::String &value)
 
UserWithArn (Aws::String &&value)
 
UserWithArn (const char *value)
 
const Aws::Utils::DateTimeGetCreateDate () const
 
bool CreateDateHasBeenSet () const
 
void SetCreateDate (const Aws::Utils::DateTime &value)
 
void SetCreateDate (Aws::Utils::DateTime &&value)
 
UserWithCreateDate (const Aws::Utils::DateTime &value)
 
UserWithCreateDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetPasswordLastUsed () const
 
bool PasswordLastUsedHasBeenSet () const
 
void SetPasswordLastUsed (const Aws::Utils::DateTime &value)
 
void SetPasswordLastUsed (Aws::Utils::DateTime &&value)
 
UserWithPasswordLastUsed (const Aws::Utils::DateTime &value)
 
UserWithPasswordLastUsed (Aws::Utils::DateTime &&value)
 
const AttachedPermissionsBoundaryGetPermissionsBoundary () const
 
bool PermissionsBoundaryHasBeenSet () const
 
void SetPermissionsBoundary (const AttachedPermissionsBoundary &value)
 
void SetPermissionsBoundary (AttachedPermissionsBoundary &&value)
 
UserWithPermissionsBoundary (const AttachedPermissionsBoundary &value)
 
UserWithPermissionsBoundary (AttachedPermissionsBoundary &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
UserWithTags (const Aws::Vector< Tag > &value)
 
UserWithTags (Aws::Vector< Tag > &&value)
 
UserAddTags (const Tag &value)
 
UserAddTags (Tag &&value)
 

Detailed Description

Contains information about an IAM user entity.

This data type is used as a response element in the following operations:

See Also:

AWS API Reference

Definition at line 38 of file User.h.

Constructor & Destructor Documentation

◆ User() [1/2]

Aws::IAM::Model::User::User ( )

◆ User() [2/2]

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

Member Function Documentation

◆ AddTags() [1/2]

User& Aws::IAM::Model::User::AddTags ( const Tag value)
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 532 of file User.h.

◆ AddTags() [2/2]

User& Aws::IAM::Model::User::AddTags ( Tag &&  value)
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 540 of file User.h.

◆ ArnHasBeenSet()

bool Aws::IAM::Model::User::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 226 of file User.h.

◆ CreateDateHasBeenSet()

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

The date and time, in ISO 8601 date-time format, when the user was created.

Definition at line 287 of file User.h.

◆ GetArn()

const Aws::String& Aws::IAM::Model::User::GetArn ( ) const
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 218 of file User.h.

◆ GetCreateDate()

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

The date and time, in ISO 8601 date-time format, when the user was created.

Definition at line 281 of file User.h.

◆ GetPasswordLastUsed()

const Aws::Utils::DateTime& Aws::IAM::Model::User::GetPasswordLastUsed ( ) const
inline

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Definition at line 331 of file User.h.

◆ GetPath()

const Aws::String& Aws::IAM::Model::User::GetPath ( ) const
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 54 of file User.h.

◆ GetPermissionsBoundary()

const AttachedPermissionsBoundary& Aws::IAM::Model::User::GetPermissionsBoundary ( ) const
inline

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 435 of file User.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::IAM::Model::User::GetTags ( ) const
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 484 of file User.h.

◆ GetUserId()

const Aws::String& Aws::IAM::Model::User::GetUserId ( ) const
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 153 of file User.h.

◆ GetUserName()

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

The friendly name identifying the user.

Definition at line 109 of file User.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PasswordLastUsedHasBeenSet()

bool Aws::IAM::Model::User::PasswordLastUsedHasBeenSet ( ) const
inline

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Definition at line 350 of file User.h.

◆ PathHasBeenSet()

bool Aws::IAM::Model::User::PathHasBeenSet ( ) const
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 61 of file User.h.

◆ PermissionsBoundaryHasBeenSet()

bool Aws::IAM::Model::User::PermissionsBoundaryHasBeenSet ( ) const
inline

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 443 of file User.h.

◆ SetArn() [1/3]

void Aws::IAM::Model::User::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 234 of file User.h.

◆ SetArn() [2/3]

void Aws::IAM::Model::User::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 242 of file User.h.

◆ SetArn() [3/3]

void Aws::IAM::Model::User::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 250 of file User.h.

◆ SetCreateDate() [1/2]

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

The date and time, in ISO 8601 date-time format, when the user was created.

Definition at line 293 of file User.h.

◆ SetCreateDate() [2/2]

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

The date and time, in ISO 8601 date-time format, when the user was created.

Definition at line 299 of file User.h.

◆ SetPasswordLastUsed() [1/2]

void Aws::IAM::Model::User::SetPasswordLastUsed ( const Aws::Utils::DateTime value)
inline

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Definition at line 369 of file User.h.

◆ SetPasswordLastUsed() [2/2]

void Aws::IAM::Model::User::SetPasswordLastUsed ( Aws::Utils::DateTime &&  value)
inline

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Definition at line 388 of file User.h.

◆ SetPath() [1/3]

void Aws::IAM::Model::User::SetPath ( const Aws::String value)
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 68 of file User.h.

◆ SetPath() [2/3]

void Aws::IAM::Model::User::SetPath ( Aws::String &&  value)
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 75 of file User.h.

◆ SetPath() [3/3]

void Aws::IAM::Model::User::SetPath ( const char *  value)
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 82 of file User.h.

◆ SetPermissionsBoundary() [1/2]

void Aws::IAM::Model::User::SetPermissionsBoundary ( const AttachedPermissionsBoundary value)
inline

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 451 of file User.h.

◆ SetPermissionsBoundary() [2/2]

void Aws::IAM::Model::User::SetPermissionsBoundary ( AttachedPermissionsBoundary &&  value)
inline

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 459 of file User.h.

◆ SetTags() [1/2]

void Aws::IAM::Model::User::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 500 of file User.h.

◆ SetTags() [2/2]

void Aws::IAM::Model::User::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 508 of file User.h.

◆ SetUserId() [1/3]

void Aws::IAM::Model::User::SetUserId ( const Aws::String value)
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 169 of file User.h.

◆ SetUserId() [2/3]

void Aws::IAM::Model::User::SetUserId ( Aws::String &&  value)
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 177 of file User.h.

◆ SetUserId() [3/3]

void Aws::IAM::Model::User::SetUserId ( const char *  value)
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 185 of file User.h.

◆ SetUserName() [1/3]

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

The friendly name identifying the user.

Definition at line 119 of file User.h.

◆ SetUserName() [2/3]

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

The friendly name identifying the user.

Definition at line 124 of file User.h.

◆ SetUserName() [3/3]

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

The friendly name identifying the user.

Definition at line 129 of file User.h.

◆ TagsHasBeenSet()

bool Aws::IAM::Model::User::TagsHasBeenSet ( ) const
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 492 of file User.h.

◆ UserIdHasBeenSet()

bool Aws::IAM::Model::User::UserIdHasBeenSet ( ) const
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 161 of file User.h.

◆ UserNameHasBeenSet()

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

The friendly name identifying the user.

Definition at line 114 of file User.h.

◆ WithArn() [1/3]

User& Aws::IAM::Model::User::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 258 of file User.h.

◆ WithArn() [2/3]

User& Aws::IAM::Model::User::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 266 of file User.h.

◆ WithArn() [3/3]

User& Aws::IAM::Model::User::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Definition at line 274 of file User.h.

◆ WithCreateDate() [1/2]

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

The date and time, in ISO 8601 date-time format, when the user was created.

Definition at line 305 of file User.h.

◆ WithCreateDate() [2/2]

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

The date and time, in ISO 8601 date-time format, when the user was created.

Definition at line 311 of file User.h.

◆ WithPasswordLastUsed() [1/2]

User& Aws::IAM::Model::User::WithPasswordLastUsed ( const Aws::Utils::DateTime value)
inline

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Definition at line 407 of file User.h.

◆ WithPasswordLastUsed() [2/2]

User& Aws::IAM::Model::User::WithPasswordLastUsed ( Aws::Utils::DateTime &&  value)
inline

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Definition at line 426 of file User.h.

◆ WithPath() [1/3]

User& Aws::IAM::Model::User::WithPath ( const Aws::String value)
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 89 of file User.h.

◆ WithPath() [2/3]

User& Aws::IAM::Model::User::WithPath ( Aws::String &&  value)
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 96 of file User.h.

◆ WithPath() [3/3]

User& Aws::IAM::Model::User::WithPath ( const char *  value)
inline

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 103 of file User.h.

◆ WithPermissionsBoundary() [1/2]

User& Aws::IAM::Model::User::WithPermissionsBoundary ( const AttachedPermissionsBoundary value)
inline

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 467 of file User.h.

◆ WithPermissionsBoundary() [2/2]

User& Aws::IAM::Model::User::WithPermissionsBoundary ( AttachedPermissionsBoundary &&  value)
inline

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 475 of file User.h.

◆ WithTags() [1/2]

User& Aws::IAM::Model::User::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 516 of file User.h.

◆ WithTags() [2/2]

User& Aws::IAM::Model::User::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Definition at line 524 of file User.h.

◆ WithUserId() [1/3]

User& Aws::IAM::Model::User::WithUserId ( const Aws::String value)
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 193 of file User.h.

◆ WithUserId() [2/3]

User& Aws::IAM::Model::User::WithUserId ( Aws::String &&  value)
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 201 of file User.h.

◆ WithUserId() [3/3]

User& Aws::IAM::Model::User::WithUserId ( const char *  value)
inline

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 209 of file User.h.

◆ WithUserName() [1/3]

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

The friendly name identifying the user.

Definition at line 134 of file User.h.

◆ WithUserName() [2/3]

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

The friendly name identifying the user.

Definition at line 139 of file User.h.

◆ WithUserName() [3/3]

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

The friendly name identifying the user.

Definition at line 144 of file User.h.


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