AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The group type.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.GroupType

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class GroupType

The GroupType type exposes the following members

Constructors

NameDescription
Public Method GroupType()

Properties

NameTypeDescription
Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The date and time, in ISO 8601 format, when the item was created.

Public Property Description System.String

Gets and sets the property Description.

A string containing the description of the group.

Public Property GroupName System.String

Gets and sets the property GroupName.

The name of the group.

Public Property LastModifiedDate System.DateTime

Gets and sets the property LastModifiedDate.

The date and time, in ISO 8601 format, when the item was modified.

Public Property Precedence System.Int32

Gets and sets the property 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 ornull 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.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

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

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The user pool ID for the user pool.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5