GetUserPoolGroupResult

data class GetUserPoolGroupResult(val description: String? = null, val precedence: Int? = null, val roleArn: String? = null)

Constructors

Link copied to clipboard
constructor(description: String? = null, precedence: Int? = null, roleArn: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val description: String? = null

A string containing the description of the group.

Link copied to clipboard
val precedence: Int? = null

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 .

Link copied to clipboard
val roleArn: String? = null

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