Class GroupType
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GroupType.Builder,
GroupType>
The group type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GroupType.Builder
builder()
final Instant
The date and time when the item was created.final String
A string containing the description of the group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
The name of the group.final int
hashCode()
final Instant
The date and time when the item was modified.final Integer
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.final String
roleArn()
The role Amazon Resource Name (ARN) for the group.static Class
<? extends GroupType.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The user pool ID for the user pool.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
groupName
The name of the group.
- Returns:
- The name of the group.
-
userPoolId
The user pool ID for the user pool.
- Returns:
- The user pool ID for the user pool.
-
description
A string containing the description of the group.
- Returns:
- A string containing the description of the group.
-
roleArn
The role Amazon Resource Name (ARN) for the group.
- Returns:
- The role Amazon Resource Name (ARN) for the group.
-
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.- Returns:
- 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.
-
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.- Returns:
- 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.
-
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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GroupType.Builder,
GroupType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-