interface CfnUserPoolGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnUserPoolGroupProps
Java	software.amazon.awscdk.services.cognito.CfnUserPoolGroupProps
Python	aws_cdk.aws_cognito.CfnUserPoolGroupProps
TypeScript	@aws-cdk/aws-cognito » CfnUserPoolGroupProps

Properties for defining a CfnUserPoolGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';
const cfnUserPoolGroupProps: cognito.CfnUserPoolGroupProps = {
  userPoolId: 'userPoolId',

  // the properties below are optional
  description: 'description',
  groupName: 'groupName',
  precedence: 123,
  roleArn: 'roleArn',
};

Properties

Name	Type	Description
userPoolId	string	The user pool ID for the user pool.
description?	string	A string containing the description of the group.
groupName?	string	The name of the group.
precedence?	number	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.
roleArn?	string	The role Amazon Resource Name (ARN) for the group.

---

userPoolId

Type: string

The user pool ID for the user pool.

---

description?

Type: string (optional)

A string containing the description of the group.

---

groupName?

Type: string (optional)

The name of the group.

Must be unique.

---

precedence?

Type: number (optional)

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 .

---

roleArn?

Type: string (optional)

The role Amazon Resource Name (ARN) for the group.