NAME

Paws::CognitoIdp::GroupType

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CognitoIdp::GroupType object:

  $service_obj->Method(Att1 => { CreationDate => $value, ..., UserPoolId => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::GroupType object:

  $result = $service_obj->Method(...);
  $result->Att1->CreationDate

DESCRIPTION

The group type.

ATTRIBUTES

CreationDate => Str

  The date the group was created.

Description => Str

  A string containing the description of the group.

GroupName => Str

  The name of the group.

LastModifiedDate => Str

  The date the group was last modified.

Precedence => Int

  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. If a user belongs to two or more groups, it is the group with the
highest precedence whose role ARN will be used in the C<cognito:roles>
and C<cognito:preferred_role> claims in the user's tokens. Groups with
higher C<Precedence> values take precedence over groups with lower
C<Precedence> values or with null C<Precedence> values.

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.

RoleArn => Str

  The role ARN for the group.

UserPoolId => Str

  The user pool ID for the user pool.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues