com.amazonaws.services.cognitoidentityprovider.model

Class CreateGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.CreateGroupRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Creates a new group in the specified user pool.

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
CreateGroupRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() A string containing the description of the group.
java.lang.String	getGroupName() The name of the group.
java.lang.Integer	getPrecedence() A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.
java.lang.String	getRoleArn() The 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 description of the group.
void	setGroupName(java.lang.String groupName) The name of the group.
void	setPrecedence(java.lang.Integer precedence) A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.
void	setRoleArn(java.lang.String roleArn) The 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.
CreateGroupRequest	withDescription(java.lang.String description) A string containing the description of the group.
CreateGroupRequest	withGroupName(java.lang.String groupName) The name of the group.
CreateGroupRequest	withPrecedence(java.lang.Integer precedence) A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.
CreateGroupRequest	withRoleArn(java.lang.String roleArn) The role Amazon Resource Name (ARN) for the group.
CreateGroupRequest	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

CreateGroupRequest

public CreateGroupRequest()

Method Detail

getGroupName

public java.lang.String getGroupName()

The name of the group. Must be unique.

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

Returns:

The name of the group. Must be unique.

setGroupName

public void setGroupName(java.lang.String groupName)

The name of the group. Must be unique.

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

Parameters:

groupName -

The name of the group. Must be unique.

withGroupName

public CreateGroupRequest withGroupName(java.lang.String groupName)

The name of the group. Must be unique.

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. Must be unique.

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 CreateGroupRequest 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 description of the group.

Constraints:
Length: - 2048

Returns:

A string containing the description of the group.

setDescription

public void setDescription(java.lang.String description)

A string containing the description of the group.

Constraints:
Length: - 2048

Parameters:

description -

A string containing the description of the group.

withDescription

public CreateGroupRequest withDescription(java.lang.String description)

A string containing the 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 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 role Amazon Resource Name (ARN) for the group.

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

Returns:

The role Amazon Resource Name (ARN) for the group.

setRoleArn

public void setRoleArn(java.lang.String roleArn)

The role Amazon Resource Name (ARN) for the group.

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

Parameters:

roleArn -

The role Amazon Resource Name (ARN) for the group.

withRoleArn

public CreateGroupRequest withRoleArn(java.lang.String roleArn)

The role Amazon Resource Name (ARN) for the group.

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 role Amazon Resource Name (ARN) for the group.

Returns:

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

getPrecedence

public java.lang.Integer getPrecedence()

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

Constraints:
Range: 0 -

Returns:

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

setPrecedence

public void setPrecedence(java.lang.Integer precedence)

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

Constraints:
Range: 0 -

Parameters:

precedence -

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

withPrecedence

public CreateGroupRequest withPrecedence(java.lang.Integer precedence)

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

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

Constraints:
Range: 0 -

Parameters:

precedence -

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

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