java.lang.Object
- software.amazon.awssdk.services.cognitoidentityprovider.model.GroupType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GroupType.Builder,GroupType>
```
@Generated("software.amazon.awssdk:codegen")
public final class GroupType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GroupType.Builder,GroupType>
```
A user pool group. Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.

This data type is a response parameter of AdminListGroupsForUser, CreateGroup, GetGroup, ListGroups, and UpdateGroup .

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GroupType.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GroupType.Builder`	`builder()`
`Instant`	`creationDate()`	The date and time when the item was created.
`String`	`description()`	A friendly description of the group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`groupName()`	The name of the group.
`int`	`hashCode()`
`Instant`	`lastModifiedDate()`	The date and time when the item was modified.
`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.
`String`	`roleArn()`	The ARN of the IAM role associated with the group.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GroupType.Builder>`	`serializableBuilderClass()`
`GroupType.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userPoolId()`	The ID of the user pool that contains the group.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - groupName
```
public final String groupName()
```
    The name of the group.
    
    Returns:
    
    The name of the group.
  - userPoolId
```
public final String userPoolId()
```
    The ID of the user pool that contains the group.
    
    Returns:
    
    The ID of the user pool that contains the group.
  - description
```
public final String description()
```
    A friendly description of the group.
    
    Returns:
    
    A friendly description of the group.
  - roleArn
```
public final String roleArn()
```
    The ARN of the IAM role associated with the group. If a group has the highest priority of a user's groups, users who authenticate with an identity pool get credentials for the RoleArn that's associated with the group.
    
    Returns:
    
    The ARN of the IAM role associated with the group. If a group has the highest priority of a user's groups, users who authenticate with an identity pool get credentials for the RoleArn that's associated with the group.
  - precedence
```
public final 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 ornull 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.
    
    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 ornull 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.
  - lastModifiedDate
```
public final Instant lastModifiedDate()
```
    The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Returns:
    
    The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
  - creationDate
```
public final Instant creationDate()
```
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Returns:
    
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
  - toBuilder
```
public GroupType.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GroupType.Builder,GroupType>
  - builder
```
public static GroupType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GroupType.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GroupType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

groupName

userPoolId

description

roleArn

precedence

lastModifiedDate

creationDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField