class Aws::CognitoIdentityProvider::Types::CreateGroupRequest

@note When making an API call, you may pass CreateGroupRequest

data as a hash:

    {
      group_name: "GroupNameType", # required
      user_pool_id: "UserPoolIdType", # required
      description: "DescriptionType",
      role_arn: "ArnType",
      precedence: 1,
    }

@!attribute [rw] group_name

The name of the group. Must be unique.
@return [String]

@!attribute [rw] user_pool_id

The user pool ID for the user pool.
@return [String]

@!attribute [rw] description

A string containing the description of the group.
@return [String]

@!attribute [rw] role_arn

The role ARN for the group.
@return [String]

@!attribute [rw] 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. 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 will be
used in the `cognito:roles` and `cognito:preferred_role` claims in
the user's tokens.

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.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroupRequest AWS API Documentation

Constants

SENSITIVE