@Generated(value="software.amazon.awssdk:codegen") public final class GroupType extends Object implements StructuredPojo, ToCopyableBuilder<GroupType.Builder,GroupType>
The group type.
Modifier and Type | Class and Description |
---|---|
static interface |
GroupType.Builder |
Modifier and Type | Method and Description |
---|---|
static GroupType.Builder |
builder() |
Instant |
creationDate()
The date the group was created.
|
String |
description()
A string containing the description of the group.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
groupName()
The name of the group.
|
int |
hashCode() |
Instant |
lastModifiedDate()
The date the group was last modified.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Integer |
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.
|
String |
roleArn()
The role ARN for the group.
|
static Class<? extends GroupType.Builder> |
serializableBuilderClass() |
GroupType.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
userPoolId()
The user pool ID for the user pool.
|
copy
public String groupName()
The name of the group.
public String userPoolId()
The user pool ID for the user pool.
public String description()
A string containing the description of the group.
public String roleArn()
The role ARN for the group.
public Integer 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. 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.
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.
public Instant lastModifiedDate()
The date the group was last modified.
public Instant creationDate()
The date the group was created.
public GroupType.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GroupType.Builder,GroupType>
public static GroupType.Builder builder()
public static Class<? extends GroupType.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.