UpdateGroupRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.identitymanagement.model.UpdateGroupRequest

All Implemented Interfaces:

Serializable
```
public class UpdateGroupRequest
extends AmazonWebServiceRequest
implements Serializable
```
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 Using AWS Identity and Access Management.

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

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
`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
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
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: (/)|(/[!-]+/)
    
    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: (/)|(/[!-]+/)
    
    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: (/)|(/[!-]+/)
    
    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

Did this page help you?

Class UpdateGroupRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateGroupRequest

UpdateGroupRequest

Method Detail

getGroupName

setGroupName

withGroupName

getNewPath

setNewPath

withNewPath

getNewGroupName

setNewGroupName

withNewGroupName

toString

hashCode

equals