Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface GroupType.Builder

All Superinterfaces:

CopyableBuilder<GroupType.Builder,GroupType>, SdkBuilder<GroupType.Builder,GroupType>

Enclosing class:

GroupType

public static interface GroupType.Builder
extends CopyableBuilder<GroupType.Builder,GroupType>

Method Summary

Modifier and Type	Method	Description
GroupType.Builder	creationDate(Date creationDate)	The date the group was created.
GroupType.Builder	description(String description)	A string containing the description of the group.
GroupType.Builder	groupName(String groupName)	The name of the group.
GroupType.Builder	lastModifiedDate(Date lastModifiedDate)	The date the group was last modified.
GroupType.Builder	precedence(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.
GroupType.Builder	roleArn(String roleArn)	The role ARN for the group.
GroupType.Builder	userPoolId(String userPoolId)	The user pool ID for the user pool.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

groupName

GroupType.Builder groupName(String groupName)

The name of the group.

Parameters:

groupName - The name of the group.

Returns:

Returns a reference to this object so that method calls can be chained together.

userPoolId

GroupType.Builder userPoolId(String userPoolId)

The user pool ID for the user pool.

Parameters:

userPoolId - The user pool ID for the user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

GroupType.Builder description(String description)

A string containing the description of the group.

Parameters:

description - A string containing the description of the group.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

GroupType.Builder roleArn(String roleArn)

The role ARN for the group.

Parameters:

roleArn - The role ARN for the group.

Returns:

Returns a reference to this object so that method calls can be chained together.

precedence

GroupType.Builder precedence(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedDate

GroupType.Builder lastModifiedDate(Date lastModifiedDate)

The date the group was last modified.

Parameters:

lastModifiedDate - The date the group was last modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationDate

GroupType.Builder creationDate(Date creationDate)

The date the group was created.

Parameters:

creationDate - The date the group was created.

Returns:

Returns a reference to this object so that method calls can be chained together.