com.amazonaws.services.cognitoidentityprovider.model

Class UpdateGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.UpdateGroupRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UpdateGroupRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Updates the specified group with the specified attributes.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateGroupRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() A string containing the new description of the group.
java.lang.String	getGroupName() The name of the group.
java.lang.Integer	getPrecedence() The new precedence value for the group.
java.lang.String	getRoleArn() The new role Amazon Resource Name (ARN) for the group.
java.lang.String	getUserPoolId() The user pool ID for the user pool.
int	hashCode()
void	setDescription(java.lang.String description) A string containing the new description of the group.
void	setGroupName(java.lang.String groupName) The name of the group.
void	setPrecedence(java.lang.Integer precedence) The new precedence value for the group.
void	setRoleArn(java.lang.String roleArn) The new role Amazon Resource Name (ARN) for the group.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateGroupRequest	withDescription(java.lang.String description) A string containing the new description of the group.
UpdateGroupRequest	withGroupName(java.lang.String groupName) The name of the group.
UpdateGroupRequest	withPrecedence(java.lang.Integer precedence) The new precedence value for the group.
UpdateGroupRequest	withRoleArn(java.lang.String roleArn) The new role Amazon Resource Name (ARN) for the group.
UpdateGroupRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID for the user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateGroupRequest

public UpdateGroupRequest()

Method Detail

getGroupName

public java.lang.String getGroupName()

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The name of the group.

setGroupName

public void setGroupName(java.lang.String groupName)

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

groupName -

The name of the group.

withGroupName

public UpdateGroupRequest withGroupName(java.lang.String groupName)

The name of the group.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

groupName -

The name of the group.

Returns:

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

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID for the user pool.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool.

withUserPoolId

public UpdateGroupRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID for the user pool.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool.

Returns:

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

getDescription

public java.lang.String getDescription()

A string containing the new description of the group.

Constraints:
Length: - 2048

Returns:

A string containing the new description of the group.

setDescription

public void setDescription(java.lang.String description)

A string containing the new description of the group.

Constraints:
Length: - 2048

Parameters:

description -

A string containing the new description of the group.

withDescription

public UpdateGroupRequest withDescription(java.lang.String description)

A string containing the new description of the group.

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

Constraints:
Length: - 2048

Parameters:

description -

A string containing the new description of the group.

Returns:

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

getRoleArn

public java.lang.String getRoleArn()

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Returns:

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

setRoleArn

public void setRoleArn(java.lang.String roleArn)

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

roleArn -

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

withRoleArn

public UpdateGroupRequest withRoleArn(java.lang.String roleArn)

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

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

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

roleArn -

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Returns:

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

getPrecedence

public java.lang.Integer getPrecedence()

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Constraints:
Range: 0 -

Returns:

The new precedence value for the group. For more information about this parameter, see CreateGroup.

setPrecedence

public void setPrecedence(java.lang.Integer precedence)

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Constraints:
Range: 0 -

Parameters:

precedence -

The new precedence value for the group. For more information about this parameter, see CreateGroup.

withPrecedence

public UpdateGroupRequest withPrecedence(java.lang.Integer precedence)

The new precedence value for the group. For more information about this parameter, see CreateGroup.

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

Constraints:
Range: 0 -

Parameters:

precedence -

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object