Class CfnUserPoolGroupProps
Properties for defining a CfnUserPoolGroup.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserPoolGroupProps : Object, ICfnUserPoolGroupPropsSyntax (vb)
Public Class CfnUserPoolGroupProps
Inherits Object
Implements ICfnUserPoolGroupPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var cfnUserPoolGroupProps = new CfnUserPoolGroupProps {
UserPoolId = "userPoolId",
// the properties below are optional
Description = "description",
GroupName = "groupName",
Precedence = 123,
RoleArn = "roleArn"
};Synopsis
Constructors
| Cfn |
Properties
| Description | A description of the group that you're creating. |
| Group |
A name for the group. |
| 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. |
| Role |
The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. |
| User |
The ID of the user pool where you want to create a user group. |
Constructors
CfnUserPoolGroupProps()
public CfnUserPoolGroupProps()Properties
Description
A description of the group that you're creating.
public string Description { get; set; }Property Value
System.
Remarks
GroupName
A name for the group.
public string GroupName { get; set; }Property Value
System.
Remarks
This name must be unique in your user pool.
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.
public Nullable<double> Precedence { get; set; }Property Value
System.
Remarks
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
The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.
public string RoleArn { get; set; }Property Value
System.
Remarks
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.
UserPoolId
The ID of the user pool where you want to create a user group.
public string UserPoolId { get; set; }Property Value
System.