Interface ICfnUserPoolGroupProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties for defining a CfnUserPoolGroup.

public interface ICfnUserPoolGroupProps

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"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html

ExampleMetadata: fixture=_generated

Properties

Description

A string containing the description of the group.

string? Description { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-description

GroupName

The name of the group.

string? GroupName { get; }

Property Value

string

Remarks

Must be unique.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-groupname

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.

double? Precedence { get; }

Property Value

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-precedence

RoleArn

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

string? RoleArn { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-rolearn

UserPoolId

The user pool ID for the user pool.

string UserPoolId { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-userpoolid