Amazonka.CognitoIdentityProvider.Types.GroupType

Documentation

data GroupType

The group type.

See: newGroupType smart constructor.

Constructors

GroupType'

Fields

• creationDate :: Maybe POSIX

  The date the group was created.

• description :: Maybe Text

  A string containing the description of the group.

• groupName :: Maybe Text

  The name of the group.

• lastModifiedDate :: Maybe POSIX

  The date the group was last modified.

• precedence :: Maybe Natural

  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.

• roleArn :: Maybe Text

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

• userPoolId :: Maybe Text

  The user pool ID for the user pool.

Instances

FromJSON GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

Methods

parseJSON :: Value -> Parser GroupType

parseJSONList :: Value -> Parser [GroupType]

Generic GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

Associated Types

type Rep GroupType :: Type -> Type

Methods

from :: GroupType -> Rep GroupType x

to :: Rep GroupType x -> GroupType

Read GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

Methods

readsPrec :: Int -> ReadS GroupType

readList :: ReadS [GroupType]

readPrec :: ReadPrec GroupType

readListPrec :: ReadPrec [GroupType]

Show GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

Methods

showsPrec :: Int -> GroupType -> ShowS

show :: GroupType -> String

showList :: [GroupType] -> ShowS

NFData GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

Methods

rnf :: GroupType -> ()

Eq GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

Methods

(==) :: GroupType -> GroupType -> Bool

(/=) :: GroupType -> GroupType -> Bool

Hashable GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

Methods

hashWithSalt :: Int -> GroupType -> Int

hash :: GroupType -> Int

type Rep GroupType

Defined in Amazonka.CognitoIdentityProvider.Types.GroupType

type Rep GroupType = D1 ('MetaData "GroupType" "Amazonka.CognitoIdentityProvider.Types.GroupType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "GroupType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "precedence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGroupType :: GroupType

Create a value of GroupType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationDate:GroupType', groupType_creationDate - The date the group was created.

$sel:description:GroupType', groupType_description - A string containing the description of the group.

$sel:groupName:GroupType', groupType_groupName - The name of the group.

$sel:lastModifiedDate:GroupType', groupType_lastModifiedDate - The date the group was last modified.

$sel:precedence:GroupType', groupType_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.

$sel:roleArn:GroupType', groupType_roleArn - The role Amazon Resource Name (ARN) for the group.

$sel:userPoolId:GroupType', groupType_userPoolId - The user pool ID for the user pool.

groupType_creationDate :: Lens' GroupType (Maybe UTCTime)

The date the group was created.

groupType_description :: Lens' GroupType (Maybe Text)

A string containing the description of the group.

groupType_groupName :: Lens' GroupType (Maybe Text)

The name of the group.

groupType_lastModifiedDate :: Lens' GroupType (Maybe UTCTime)

The date the group was last modified.

groupType_precedence :: Lens' GroupType (Maybe Natural)

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.

groupType_roleArn :: Lens' GroupType (Maybe Text)

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

groupType_userPoolId :: Lens' GroupType (Maybe Text)

The user pool ID for the user pool.