Package software.amazon.awscdk.services.cognito

Class CfnUserPoolGroup.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnUserPoolGroup.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnUserPoolGroup.Builder.

    • userPoolId

      @Stability(Stable) public CfnUserPoolGroup.Builder userPoolId(String userPoolId)
      The user pool ID for the user pool.

      Parameters:
      userPoolId - The user pool ID for the user pool. This parameter is required.
      Returns:
      this

    • description

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

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

    • groupName

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

      Must be unique.

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

    • precedence

      @Stability(Stable) public CfnUserPoolGroup.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.

      The default Precedence value is null. The maximum Precedence value is 2^31-1 .

      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

    • roleArn

      @Stability(Stable) public CfnUserPoolGroup.Builder roleArn(String roleArn)
      The role Amazon Resource Name (ARN) for the group.

      Parameters:
      roleArn - The role Amazon Resource Name (ARN) for the group. This parameter is required.
      Returns:
      this

    • build

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