Package software.amazon.awscdk.services.cognito

Class UserPoolGroupOptions.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • description

      @Stability(Stable) public UserPoolGroupOptions.Builder description(String description)
      Sets the value of UserPoolGroupOptions.getDescription()
      Parameters:
      description - A string containing the description of the group.
      Returns:
      this

    • groupName

      @Stability(Stable) public UserPoolGroupOptions.Builder groupName(String groupName)
      Sets the value of UserPoolGroupOptions.getGroupName()
      Parameters:
      groupName - The name of the group. Must be unique.
      Returns:
      this

    • precedence

      @Stability(Stable) public UserPoolGroupOptions.Builder precedence(Number precedence)
      Sets the value of UserPoolGroupOptions.getPrecedence()
      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 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.

      Returns:
      this

    • role

      @Stability(Stable) public UserPoolGroupOptions.Builder role(IRole role)
      Sets the value of UserPoolGroupOptions.getRole()
      Parameters:
      role - The role for the group.
      Returns:
      this

    • build

      @Stability(Stable) public UserPoolGroupOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<UserPoolGroupOptions>
      Returns:
      a new instance of UserPoolGroupOptions
      Throws:
      NullPointerException - if any required attribute was not provided