com.amazonaws.services.cognitoidp.model

Class CreateGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.CreateGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateGroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() A string containing the description of the group.
String	getGroupName() The name of the group.
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.
String	getRoleArn() The role Amazon Resource Name (ARN) for the group.
String	getUserPoolId() The user pool ID for the user pool.
int	hashCode()
void	setDescription(String description) A string containing the description of the group.
void	setGroupName(String groupName) The name of the group.
void	setPrecedence(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(String roleArn) The role Amazon Resource Name (ARN) for the group.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool.
String	toString() Returns a string representation of this object.
CreateGroupRequest	withDescription(String description) A string containing the description of the group.
CreateGroupRequest	withGroupName(String groupName) The name of the group.
CreateGroupRequest	withPrecedence(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(String roleArn) The role Amazon Resource Name (ARN) for the group.
CreateGroupRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGroupRequest

public CreateGroupRequest()

Method Detail

setGroupName

public void setGroupName(String groupName)

The name of the group. Must be unique.

Parameters:

groupName - The name of the group. Must be unique.

getGroupName

public String getGroupName()

The name of the group. Must be unique.

Returns:

The name of the group. Must be unique.

withGroupName

public CreateGroupRequest withGroupName(String groupName)

The name of the group. Must be unique.

Parameters:

groupName - The name of the group. Must be unique.

Returns:

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

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool.

Parameters:

userPoolId - The user pool ID for the user pool.

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool.

Returns:

The user pool ID for the user pool.

withUserPoolId

public CreateGroupRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool.

Parameters:

userPoolId - The user pool ID for the user pool.

Returns:

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

setDescription

public void setDescription(String description)

A string containing the description of the group.

Parameters:

description - A string containing the description of the group.

getDescription

public String getDescription()

A string containing the description of the group.

Returns:

A string containing the description of the group.

withDescription

public CreateGroupRequest withDescription(String description)

A string containing the description of the group.

Parameters:

description - A string containing the description of the group.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

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

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public CreateGroupRequest withRoleArn(String roleArn)

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

Parameters:

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

Returns:

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

setPrecedence

public void setPrecedence(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.

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.

getPrecedence

public 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.

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.

withPrecedence

public CreateGroupRequest withPrecedence(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.

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:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()