com.amazonaws.services.identitymanagement.model

Class UpdateGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.UpdateGroupRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateGroup operation.

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

IMPORTANT: You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.

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

See Also:

AmazonIdentityManagement.updateGroup(UpdateGroupRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateGroupRequest() Default constructor for a new UpdateGroupRequest object.
UpdateGroupRequest(String groupName) Constructs a new UpdateGroupRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
UpdateGroupRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getGroupName() Name of the group to update.
String	getNewGroupName() New name for the group.
String	getNewPath() New path for the group.
int	hashCode()
void	setGroupName(String groupName) Name of the group to update.
void	setNewGroupName(String newGroupName) New name for the group.
void	setNewPath(String newPath) New path for the group.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateGroupRequest	withGroupName(String groupName) Name of the group to update.
UpdateGroupRequest	withNewGroupName(String newGroupName) New name for the group.
UpdateGroupRequest	withNewPath(String newPath) New path for the group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateGroupRequest

public UpdateGroupRequest()

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

UpdateGroupRequest

public UpdateGroupRequest(String groupName)

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

Parameters:

groupName - Name of the group to update. If you're changing the name of the group, this is the original name.

Method Detail

getGroupName

public String getGroupName()

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

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

Returns:

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

setGroupName

public void setGroupName(String groupName)

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

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

Parameters:

groupName - Name of the group to update. If you're changing the name of the group, this is the original name.

withGroupName

public UpdateGroupRequest withGroupName(String groupName)

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

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

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

Parameters:

groupName - Name of the group to update. If you're changing the name of the group, this is the original name.

Returns:

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

getNewPath

public String getNewPath()

New path for the group. Only include this if changing the group's path.

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

Returns:

New path for the group. Only include this if changing the group's path.

setNewPath

public void setNewPath(String newPath)

New path for the group. Only include this if changing the group's path.

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

Parameters:

newPath - New path for the group. Only include this if changing the group's path.

withNewPath

public UpdateGroupRequest withNewPath(String newPath)

New path for the group. Only include this if changing the group's path.

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:

newPath - New path for the group. Only include this if changing the group's path.

Returns:

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

getNewGroupName

public String getNewGroupName()

New name for the group. Only include this if changing the group's name.

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

Returns:

New name for the group. Only include this if changing the group's name.

setNewGroupName

public void setNewGroupName(String newGroupName)

New name for the group. Only include this if changing the group's name.

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

Parameters:

newGroupName - New name for the group. Only include this if changing the group's name.

withNewGroupName

public UpdateGroupRequest withNewGroupName(String newGroupName)

New name for the group. Only include this if changing the group's name.

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

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

Parameters:

newGroupName - New name for the group. Only include this if changing the group'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

clone

public UpdateGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()