Interface ICfnUserPoolGroupProps
Properties for defining a CfnUserPoolGroup
.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface ICfnUserPoolGroupProps
Syntax (vb)
Public Interface ICfnUserPoolGroupProps
Remarks
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
Properties
Description | A string containing the description of the group. |
GroupName | The name of 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. |
RoleArn | The role Amazon Resource Name (ARN) for the group. |
UserPoolId | The user pool ID for the user pool. |
Properties
Description
A string containing the description of the group.
virtual string Description { get; }
Property Value
System.String
Remarks
GroupName
The name of the group.
virtual string GroupName { get; }
Property Value
System.String
Remarks
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.
virtual Nullable<double> Precedence { get; }
Property Value
System.Nullable<System.Double>
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 role Amazon Resource Name (ARN) for the group.
virtual string RoleArn { get; }
Property Value
System.String
Remarks
UserPoolId
The user pool ID for the user pool.
string UserPoolId { get; }
Property Value
System.String