Package software.amazon.awscdk.services.cognito

Class CfnUserPoolGroupProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • userPoolId

      @Stability(Stable) public CfnUserPoolGroupProps.Builder userPoolId(String userPoolId)
      Sets the value of CfnUserPoolGroupProps.getUserPoolId()
      Parameters:
      userPoolId - The ID of the user pool where you want to create a user group. This parameter is required.
      Returns:
      this

    • userPoolId

      @Stability(Stable) public CfnUserPoolGroupProps.Builder userPoolId(IUserPoolRef userPoolId)
      Sets the value of CfnUserPoolGroupProps.getUserPoolId()
      Parameters:
      userPoolId - The ID of the user pool where you want to create a user group. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnUserPoolGroupProps.Builder description(String description)
      Sets the value of CfnUserPoolGroupProps.getDescription()
      Parameters:
      description - A description of the group that you're creating.
      Returns:
      this

    • groupName

      @Stability(Stable) public CfnUserPoolGroupProps.Builder groupName(String groupName)
      Sets the value of CfnUserPoolGroupProps.getGroupName()
      Parameters:
      groupName - A name for the group. This name must be unique in your user pool.
      Returns:
      this

    • precedence

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

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

      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnUserPoolGroupProps.Builder roleArn(String roleArn)
      Sets the value of CfnUserPoolGroupProps.getRoleArn()
      Parameters:
      roleArn - The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a cognito:groups claim that list all the groups that a user is a member of.
      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnUserPoolGroupProps.Builder roleArn(IRoleRef roleArn)
      Sets the value of CfnUserPoolGroupProps.getRoleArn()
      Parameters:
      roleArn - The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a cognito:groups claim that list all the groups that a user is a member of.
      Returns:
      this

    • build

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