GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::CognitoIdp::GroupType(3) User Contributed Perl Documentation Paws::CognitoIdp::GroupType(3)

Paws::CognitoIdp::GroupType

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

The group type.

The date the group was created.

A string containing the description of the group.

The name of the group.

The date the group was last modified.

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 "cognito:roles" and "cognito:preferred_role" claims in the user's tokens. Groups with higher "Precedence" values take precedence over groups with lower "Precedence" values or with null "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.

The role ARN for the group.

The user pool ID for the user pool.

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

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>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.