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

Interface GroupType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GroupType.Builder,GroupType>, SdkBuilder<GroupType.Builder,GroupType>, SdkPojo
Enclosing class:
GroupType
@Mutable @NotThreadSafe public static interface GroupType.Builder extends SdkPojo, CopyableBuilder<GroupType.Builder,GroupType>

  • Method Details

    • 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 ID of the user pool that contains the group.

      Parameters:
      userPoolId - The ID of the user pool that contains the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      GroupType.Builder description(String description)

      A friendly description of the group.

      Parameters:
      description - A friendly 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 ARN of the IAM role associated with the group. If a group has the highest priority of a user's groups, users who authenticate with an identity pool get credentials for the RoleArn that's associated with the group.

      Parameters:
      roleArn - The ARN of the IAM role associated with the group. If a group has the highest priority of a user's groups, users who authenticate with an identity pool get credentials for the RoleArn that's associated with the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • precedence

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

      Parameters:
      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.

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

    • lastModifiedDate

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.