/AWS1/CL_CGPGROUPTYPE¶
The group type.
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
IV_GROUPNAME
TYPE /AWS1/CGPGROUPNAMETYPE
/AWS1/CGPGROUPNAMETYPE
¶
The name of the group.
IV_USERPOOLID
TYPE /AWS1/CGPUSERPOOLIDTYPE
/AWS1/CGPUSERPOOLIDTYPE
¶
The user pool ID for the user pool.
IV_DESCRIPTION
TYPE /AWS1/CGPDESCRIPTIONTYPE
/AWS1/CGPDESCRIPTIONTYPE
¶
A string containing the description of the group.
IV_ROLEARN
TYPE /AWS1/CGPARNTYPE
/AWS1/CGPARNTYPE
¶
The role Amazon Resource Name (ARN) for the group.
IV_PRECEDENCE
TYPE /AWS1/CGPPRECEDENCETYPE
/AWS1/CGPPRECEDENCETYPE
¶
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 ornullPrecedence
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 thecognito:roles
andcognito:preferred_role
claims.Two groups can have the same
Precedence
value. If this happens, neither group takes precedence over the other. If two groups with the samePrecedence
have the same role ARN, that role is used in thecognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_role
claim isn't set in users' tokens.The default
Precedence
value is null.
IV_LASTMODIFIEDDATE
TYPE /AWS1/CGPDATETYPE
/AWS1/CGPDATETYPE
¶
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.
IV_CREATIONDATE
TYPE /AWS1/CGPDATETYPE
/AWS1/CGPDATETYPE
¶
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.
Queryable Attributes¶
GroupName¶
The name of the group.
Accessible with the following methods¶
Method | Description |
---|---|
GET_GROUPNAME() |
Getter for GROUPNAME, with configurable default |
ASK_GROUPNAME() |
Getter for GROUPNAME w/ exceptions if field has no value |
HAS_GROUPNAME() |
Determine if GROUPNAME has a value |
UserPoolId¶
The user pool ID for the user pool.
Accessible with the following methods¶
Method | Description |
---|---|
GET_USERPOOLID() |
Getter for USERPOOLID, with configurable default |
ASK_USERPOOLID() |
Getter for USERPOOLID w/ exceptions if field has no value |
HAS_USERPOOLID() |
Determine if USERPOOLID has a value |
Description¶
A string containing the description of the group.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
RoleArn¶
The role Amazon Resource Name (ARN) for the group.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
Precedence¶
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 ornullPrecedence
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 thecognito:roles
andcognito:preferred_role
claims.Two groups can have the same
Precedence
value. If this happens, neither group takes precedence over the other. If two groups with the samePrecedence
have the same role ARN, that role is used in thecognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_role
claim isn't set in users' tokens.The default
Precedence
value is null.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PRECEDENCE() |
Getter for PRECEDENCE, with configurable default |
ASK_PRECEDENCE() |
Getter for PRECEDENCE w/ exceptions if field has no value |
HAS_PRECEDENCE() |
Determine if PRECEDENCE has a value |
LastModifiedDate¶
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.
Accessible with the following methods¶
Method | Description |
---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
CreationDate¶
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_GROUPLISTTYPE
¶
TYPES TT_GROUPLISTTYPE TYPE STANDARD TABLE OF REF TO /AWS1/CL_CGPGROUPTYPE WITH DEFAULT KEY
.