cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/CreateGroupRequest

CreateGroupRequest

class CreateGroupRequest

Types

Builder

class Builder

Companion

object Companion

Properties

description

val description: String?

A description of the group that you're creating.

groupName

val groupName: String?

A name for the group. This name must be unique in your user pool.

precedence

val 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

val roleArn: String?

The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a cognito:groups claim that list all the groups that a user is a member of.

userPoolId

val userPoolId: String?

The ID of the user pool where you want to create a user group.

Functions

copy

inline fun copy(block: CreateGroupRequest.Builder.() -> Unit = {}): CreateGroupRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String