@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GroupType extends Object implements Serializable, Cloneable, StructuredPojo
The group type.
Constructor and Description |
---|
GroupType() |
Modifier and Type | Method and Description |
---|---|
GroupType |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationDate()
The date and time, in ISO 8601 format, when
the item was created.
|
String |
getDescription()
A string containing the description of the group.
|
String |
getGroupName()
The name of the group.
|
Date |
getLastModifiedDate()
The date and time, in ISO 8601 format, when
the item was modified.
|
Integer |
getPrecedence()
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.
|
String |
getRoleArn()
The role Amazon Resource Name (ARN) for the group.
|
String |
getUserPoolId()
The user pool ID for the user pool.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when
the item was created.
|
void |
setDescription(String description)
A string containing the description of the group.
|
void |
setGroupName(String groupName)
The name of the group.
|
void |
setLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when
the item was modified.
|
void |
setPrecedence(Integer 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.
|
void |
setRoleArn(String roleArn)
The role Amazon Resource Name (ARN) for the group.
|
void |
setUserPoolId(String userPoolId)
The user pool ID for the user pool.
|
String |
toString()
Returns a string representation of this object.
|
GroupType |
withCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when
the item was created.
|
GroupType |
withDescription(String description)
A string containing the description of the group.
|
GroupType |
withGroupName(String groupName)
The name of the group.
|
GroupType |
withLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when
the item was modified.
|
GroupType |
withPrecedence(Integer 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.
|
GroupType |
withRoleArn(String roleArn)
The role Amazon Resource Name (ARN) for the group.
|
GroupType |
withUserPoolId(String userPoolId)
The user pool ID for the user pool.
|
public void setGroupName(String groupName)
The name of the group.
groupName
- The name of the group.public String getGroupName()
The name of the group.
public GroupType withGroupName(String groupName)
The name of the group.
groupName
- The name of the group.public void setUserPoolId(String userPoolId)
The user pool ID for the user pool.
userPoolId
- The user pool ID for the user pool.public String getUserPoolId()
The user pool ID for the user pool.
public GroupType withUserPoolId(String userPoolId)
The user pool ID for the user pool.
userPoolId
- The user pool ID for the user pool.public void setDescription(String description)
A string containing the description of the group.
description
- A string containing the description of the group.public String getDescription()
A string containing the description of the group.
public GroupType withDescription(String description)
A string containing the description of the group.
description
- A string containing the description of the group.public void setRoleArn(String roleArn)
The role Amazon Resource Name (ARN) for the group.
roleArn
- The role Amazon Resource Name (ARN) for the group.public String getRoleArn()
The role Amazon Resource Name (ARN) for the group.
public GroupType withRoleArn(String roleArn)
The role Amazon Resource Name (ARN) for the group.
roleArn
- The role Amazon Resource Name (ARN) for the group.public void setPrecedence(Integer 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 ornull Precedence
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
the cognito:roles
and cognito: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 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 isn't set in users' tokens.
The default Precedence
value is null.
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 ornull Precedence
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 the cognito:roles
and
cognito: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 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 isn't set in users'
tokens.
The default Precedence
value is null.
public Integer getPrecedence()
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 ornull Precedence
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
the cognito:roles
and cognito: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 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 isn't set in users' tokens.
The default Precedence
value is null.
Precedence
values take precedence over groups with higher ornull Precedence
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 the cognito:roles
and
cognito: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 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 isn't set in
users' tokens.
The default Precedence
value is null.
public GroupType withPrecedence(Integer 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 ornull Precedence
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
the cognito:roles
and cognito: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 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 isn't set in users' tokens.
The default Precedence
value is null.
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 ornull Precedence
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 the cognito:roles
and
cognito: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 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 isn't set in users'
tokens.
The default Precedence
value is null.
public void setLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when the item was modified.
lastModifiedDate
- The date and time, in ISO 8601
format, when the item was modified.public Date getLastModifiedDate()
The date and time, in ISO 8601 format, when the item was modified.
public GroupType withLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when the item was modified.
lastModifiedDate
- The date and time, in ISO 8601
format, when the item was modified.public void setCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
creationDate
- The date and time, in ISO 8601
format, when the item was created.public Date getCreationDate()
The date and time, in ISO 8601 format, when the item was created.
public GroupType withCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
creationDate
- The date and time, in ISO 8601
format, when the item was created.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.