Package software.amazon.awscdk.services.cognito

Class UserPoolGroup.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.UserPoolGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<UserPoolGroup>
Enclosing class:
UserPoolGroup
@Stability(Stable) public static final class UserPoolGroup.Builder extends Object implements software.amazon.jsii.Builder<UserPoolGroup>
A fluent builder for UserPoolGroup.

  • Method Details

    • create

      @Stability(Stable) public static UserPoolGroup.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of UserPoolGroup.Builder.

    • description

      @Stability(Stable) public UserPoolGroup.Builder description(String description)
      A string containing the description of the group.

      Default: - no description

      Parameters:
      description - A string containing the description of the group. This parameter is required.
      Returns:
      this

    • groupName

      @Stability(Stable) public UserPoolGroup.Builder groupName(String groupName)
      The name of the group.

      Must be unique.

      Default: - auto generate a name

      Parameters:
      groupName - The name of the group. This parameter is required.
      Returns:
      this

    • precedence

      @Stability(Stable) public UserPoolGroup.Builder precedence(Number 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 or null 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.

      Default: - 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. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public UserPoolGroup.Builder role(IRole role)
      The role for the group.

      Default: - no description

      Parameters:
      role - The role for the group. This parameter is required.
      Returns:
      this

    • userPool

      @Stability(Stable) public UserPoolGroup.Builder userPool(IUserPool userPool)
      The user pool to which this group is associated.

      Parameters:
      userPool - The user pool to which this group is associated. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public UserPoolGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<UserPoolGroup>
      Returns:
      a newly built instance of UserPoolGroup.