cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/UpdateGroupRequest/Builder

Builder

class Builder

Properties

description

var description: String?

A new description of the existing group.

groupName

var groupName: String?

The name of the group that you want to update.

precedence

var precedence: Int?

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.

roleArn

var roleArn: String?

The Amazon Resource Name (ARN) of an IAM role that you want to associate with the group. The role assignment contributes to the cognito:roles and cognito:preferred_role claims in group members' tokens.

userPoolId

var userPoolId: String?

The ID of the user pool that contains the group you want to update.