com.amazonaws.services.identitymanagement.model

Class User

java.lang.Object

com.amazonaws.services.identitymanagement.model.User

All Implemented Interfaces:

Serializable, Cloneable

public class User
extends Object
implements Serializable, Cloneable

Contains information about an IAM user entity.

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

• CreateUser

• GetUser

• ListUsers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
User() Default constructor for a new User object.
User(String path, String userName, String userId, String arn, Date createDate) Constructs a new User object.

Method Summary

Methods

Modifier and Type	Method and Description
User	clone()
boolean	equals(Object obj)
String	getArn() The Amazon Resource Name (ARN) that identifies the user.
Date	getCreateDate() The date and time, in ISO 8601 date-time format, when the user was created.
Date	getPasswordLastUsed() 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.
String	getPath() The path to the user.
String	getUserId() The stable and unique string identifying the user.
String	getUserName() The friendly name identifying the user.
int	hashCode()
void	setArn(String arn) The Amazon Resource Name (ARN) that identifies the user.
void	setCreateDate(Date createDate) The date and time, in ISO 8601 date-time format, when the user was created.
void	setPasswordLastUsed(Date passwordLastUsed) 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.
void	setPath(String path) The path to the user.
void	setUserId(String userId) The stable and unique string identifying the user.
void	setUserName(String userName) The friendly name identifying the user.
String	toString() Returns a string representation of this object; useful for testing and debugging.
User	withArn(String arn) The Amazon Resource Name (ARN) that identifies the user.
User	withCreateDate(Date createDate) The date and time, in ISO 8601 date-time format, when the user was created.
User	withPasswordLastUsed(Date passwordLastUsed) 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.
User	withPath(String path) The path to the user.
User	withUserId(String userId) The stable and unique string identifying the user.
User	withUserName(String userName) The friendly name identifying the user.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

User

public User()

Default constructor for a new User object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

User

public User(String path,
    String userName,
    String userId,
    String arn,
    Date createDate)

Constructs a new User object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

path - The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

userName - The friendly name identifying the user.

userId - The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

arn - 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 Using IAM guide.

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

Method Detail

getPath

public String getPath()

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

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Returns:

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

setPath

public void setPath(String path)

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

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:

path - The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

withPath

public User withPath(String path)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:

path - The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserName

public String getUserName()

The friendly name identifying the user.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Returns:

The friendly name identifying the user.

setUserName

public void setUserName(String userName)

The friendly name identifying the user.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Parameters:

userName - The friendly name identifying the user.

withUserName

public User withUserName(String userName)

The friendly name identifying the user.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*

Parameters:

userName - The friendly name identifying the user.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserId

public String getUserId()

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

Constraints:
Length: 16 - 32
Pattern: [\w]*

Returns:

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

setUserId

public void setUserId(String userId)

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

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

userId - The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

withUserId

public User withUserId(String userId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

userId - The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getArn

public String getArn()

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 Using IAM guide.

Constraints:
Length: 20 - 2048

Returns:

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 Using IAM guide.

setArn

public void setArn(String arn)

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 Using IAM guide.

Constraints:
Length: 20 - 2048

Parameters:

arn - 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 Using IAM guide.

withArn

public User withArn(String arn)

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 Using IAM guide.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048

Parameters:

arn - 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 Using IAM guide.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreateDate

public Date getCreateDate()

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

Returns:

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

setCreateDate

public void setCreateDate(Date createDate)

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

Parameters:

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

withCreateDate

public User withCreateDate(Date createDate)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getPasswordLastUsed

public Date getPasswordLastUsed()

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 Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:

• The user does not have a password

• The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014

• there is no sign-in data associated with the user

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

Returns:

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 Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:

• The user does not have a password

• The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014

• there is no sign-in data associated with the user

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

setPasswordLastUsed

public void setPasswordLastUsed(Date passwordLastUsed)

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 Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:

• The user does not have a password

• The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014

• there is no sign-in data associated with the user

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

Parameters:

passwordLastUsed - 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 Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:

• The user does not have a password

• The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014

• there is no sign-in data associated with the user

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

withPasswordLastUsed

public User withPasswordLastUsed(Date passwordLastUsed)

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 Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:

• The user does not have a password

• The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014

• there is no sign-in data associated with the user

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

passwordLastUsed - 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 Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:

• The user does not have a password

• The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014

• there is no sign-in data associated with the user

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public User clone()

Overrides:

clone in class Object