GroupType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.GroupType

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The group type.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GroupType()

Constructors
Constructor and Description
`GroupType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GroupType`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationDate()` The date the group was created.
`String`	`getDescription()` A string containing the description of the group.
`String`	`getGroupName()` The name of the group.
`Date`	`getLastModifiedDate()` The date the group was last modified.
`Integer`	`getPrecedence()` A nonnegative 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 ARN for the group.
`String`	`getUserPoolId()` The user pool ID for the user pool.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationDate(Date creationDate)` The date the group was created.
`void`	`setDescription(String description)` A string containing the description of the group.
`void`	`setGroupName(String groupName)` The name of the group.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date the group was last modified.
`void`	`setPrecedence(Integer precedence)` A nonnegative 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 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; useful for testing and debugging.
`GroupType`	`withCreationDate(Date creationDate)` The date the group was created.
`GroupType`	`withDescription(String description)` A string containing the description of the group.
`GroupType`	`withGroupName(String groupName)` The name of the group.
`GroupType`	`withLastModifiedDate(Date lastModifiedDate)` The date the group was last modified.
`GroupType`	`withPrecedence(Integer precedence)` A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.
`GroupType`	`withRoleArn(String roleArn)` The role ARN for the group.
`GroupType`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GroupType
```
public GroupType()
```
- Method Detail
  - setGroupName
```
public void setGroupName(String groupName)
```
    The name of the group.
    
    Parameters:
    
    groupName - The name of the group.
  - getGroupName
```
public String getGroupName()
```
    The name of the group.
    
    Returns:
    
    The name of the group.
  - withGroupName
```
public GroupType withGroupName(String groupName)
```
    The name of the group.
    
    Parameters:
    
    groupName - The name of the group.
    
    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 GroupType 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 GroupType 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 ARN for the group.
    
    Parameters:
    
    roleArn - The role ARN for the group.
  - getRoleArn
```
public String getRoleArn()
```
    The role ARN for the group.
    
    Returns:
    
    The role ARN for the group.
  - withRoleArn
```
public GroupType withRoleArn(String roleArn)
```
    The role ARN for the group.
    
    Parameters:
    
    roleArn - The role 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 nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.
    
    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 is not set in users' tokens.
    
    The default Precedence value is null.
    
    Parameters:
    
    precedence - A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.
    
    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 is not set in users' tokens.
    
    The default Precedence value is null.
  - getPrecedence
```
public Integer getPrecedence()
```
    A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.
    
    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 is not set in users' tokens.
    
    The default Precedence value is null.
    
    Returns:
    
    A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.
    
    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 is not set in users' tokens.
    
    The default Precedence value is null.
  - withPrecedence
```
public GroupType withPrecedence(Integer precedence)
```
    A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.
    
    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 is not set in users' tokens.
    
    The default Precedence value is null.
    
    Parameters:
    
    precedence - A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.
    
    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 is not set in users' tokens.
    
    The default Precedence value is null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date the group was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the group was last modified.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the group was last modified.
    
    Returns:
    
    The date the group was last modified.
  - withLastModifiedDate
```
public GroupType withLastModifiedDate(Date lastModifiedDate)
```
    The date the group was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the group was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the group was created.
    
    Parameters:
    
    creationDate - The date the group was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the group was created.
    
    Returns:
    
    The date the group was created.
  - withCreationDate
```
public GroupType withCreationDate(Date creationDate)
```
    The date the group was created.
    
    Parameters:
    
    creationDate - The date the group was created.
    
    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; useful for testing and debugging.
    
    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 GroupType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GroupType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GroupType

Method Detail

setGroupName

getGroupName

withGroupName

setUserPoolId

getUserPoolId

withUserPoolId

setDescription

getDescription

withDescription

setRoleArn

getRoleArn

withRoleArn

setPrecedence

getPrecedence

withPrecedence

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setCreationDate

getCreationDate

withCreationDate

toString

equals

hashCode

clone

marshall