Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.identitymanagement.model
Class UpdateUserRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.identitymanagement.model.UpdateUserRequest
All Implemented Interfaces:
Serializable

public class UpdateUserRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateUser operation.

Updates the name and/or the path of the specified user.

IMPORTANT: You should understand the implications of changing a user's path or name. For more information, see Renaming Users and Groups in Using AWS Identity and Access Management.

NOTE:To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

See Also:
AmazonIdentityManagement.updateUser(UpdateUserRequest), Serialized Form

Constructor Summary
UpdateUserRequest()
          Default constructor for a new UpdateUserRequest object.
UpdateUserRequest(String userName)
          Constructs a new UpdateUserRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 String getNewPath()
          New path for the user.
 String getNewUserName()
          New name for the user.
 String getUserName()
          Name of the user to update.
 int hashCode()
           
 void setNewPath(String newPath)
          New path for the user.
 void setNewUserName(String newUserName)
          New name for the user.
 void setUserName(String userName)
          Name of the user to update.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 UpdateUserRequest withNewPath(String newPath)
          New path for the user.
 UpdateUserRequest withNewUserName(String newUserName)
          New name for the user.
 UpdateUserRequest withUserName(String userName)
          Name of the user to update.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateUserRequest

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


UpdateUserRequest

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

Parameters:
userName - Name of the user to update. If you're changing the name of the user, this is the original user name.
Method Detail

getUserName

public String getUserName()
Name of the user to update. If you're changing the name of the user, this is the original user name.

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

Returns:
Name of the user to update. If you're changing the name of the user, this is the original user name.

setUserName

public void setUserName(String userName)
Name of the user to update. If you're changing the name of the user, this is the original user name.

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

Parameters:
userName - Name of the user to update. If you're changing the name of the user, this is the original user name.

withUserName

public UpdateUserRequest withUserName(String userName)
Name of the user to update. If you're changing the name of the user, this is the original user name.

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

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

Parameters:
userName - Name of the user to update. If you're changing the name of the user, this is the original user name.
Returns:
A reference to this updated object so that method calls can be chained together.

getNewPath

public String getNewPath()
New path for the user. Include this parameter only if you're changing the user's path.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Returns:
New path for the user. Include this parameter only if you're changing the user's path.

setNewPath

public void setNewPath(String newPath)
New path for the user. Include this parameter only if you're changing the user's path.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Parameters:
newPath - New path for the user. Include this parameter only if you're changing the user's path.

withNewPath

public UpdateUserRequest withNewPath(String newPath)
New path for the user. Include this parameter only if you're changing the user's path.

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

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Parameters:
newPath - New path for the user. Include this parameter only if you're changing the user's path.
Returns:
A reference to this updated object so that method calls can be chained together.

getNewUserName

public String getNewUserName()
New name for the user. Include this parameter only if you're changing the user's name.

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

Returns:
New name for the user. Include this parameter only if you're changing the user's name.

setNewUserName

public void setNewUserName(String newUserName)
New name for the user. Include this parameter only if you're changing the user's name.

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

Parameters:
newUserName - New name for the user. Include this parameter only if you're changing the user's name.

withNewUserName

public UpdateUserRequest withNewUserName(String newUserName)
New name for the user. Include this parameter only if you're changing the user's name.

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

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

Parameters:
newUserName - New name for the user. Include this parameter only if you're changing the user's name.
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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.