Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.Types.GroupType

Description

Synopsis

data GroupType = GroupType' {
- lastModifiedDate :: Maybe POSIX
- userPoolId :: Maybe Text
- creationDate :: Maybe POSIX
- precedence :: Maybe Natural
- groupName :: Maybe Text
- description :: Maybe Text
- roleArn :: Maybe Text
}
newGroupType :: GroupType
groupType_lastModifiedDate :: Lens' GroupType (Maybe UTCTime)
groupType_userPoolId :: Lens' GroupType (Maybe Text)
groupType_creationDate :: Lens' GroupType (Maybe UTCTime)
groupType_precedence :: Lens' GroupType (Maybe Natural)
groupType_groupName :: Lens' GroupType (Maybe Text)
groupType_description :: Lens' GroupType (Maybe Text)
groupType_roleArn :: Lens' GroupType (Maybe Text)

Documentation

data GroupType Source #

The group type.

See: newGroupType smart constructor.

Constructors

GroupType'

Fields

lastModifiedDate :: Maybe POSIX
The date the group was last modified.
userPoolId :: Maybe Text
The user pool ID for the user pool.
creationDate :: Maybe POSIX
The date the group was created.
precedence :: Maybe Natural
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.
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 is not set in users' tokens.
The default Precedence value is null.
groupName :: Maybe Text
The name of the group.
description :: Maybe Text
A string containing the description of the group.
roleArn :: Maybe Text
The role ARN for the group.

Instances

Instances details

Eq GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType Methods (==) :: GroupType -> GroupType -> Bool # (/=) :: GroupType -> GroupType -> Bool #
Read GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType Methods readsPrec :: Int -> ReadS GroupType # readList :: ReadS [GroupType] # readPrec :: ReadPrec GroupType # readListPrec :: ReadPrec [GroupType] #
Show GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType Methods showsPrec :: Int -> GroupType -> ShowS # show :: GroupType -> String # showList :: [GroupType] -> ShowS #
Generic GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType Associated Types type Rep GroupType :: Type -> Type # Methods from :: GroupType -> Rep GroupType x # to :: Rep GroupType x -> GroupType #
NFData GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType Methods rnf :: GroupType -> () #
Hashable GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType Methods hashWithSalt :: Int -> GroupType -> Int # hash :: GroupType -> Int #
FromJSON GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType Methods parseJSON :: Value -> Parser GroupType # parseJSONList :: Value -> Parser [GroupType] #
type Rep GroupType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.GroupType type Rep GroupType = D1 ('MetaData "GroupType" "Amazonka.CognitoIdentityProvider.Types.GroupType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "GroupType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "precedence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGroupType :: GroupType Source #

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:lastModifiedDate:GroupType', groupType_lastModifiedDate - The date the group was last modified.

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

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

$sel:precedence:GroupType', groupType_precedence - A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.

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 is not set in users' tokens.

The default Precedence value is null.

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

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

$sel:roleArn:GroupType', groupType_roleArn - The role ARN for the group.

groupType_lastModifiedDate :: Lens' GroupType (Maybe UTCTime) Source #

The date the group was last modified.

groupType_userPoolId :: Lens' GroupType (Maybe Text) Source #

The user pool ID for the user pool.

groupType_creationDate :: Lens' GroupType (Maybe UTCTime) Source #

The date the group was created.

groupType_precedence :: Lens' GroupType (Maybe Natural) Source #

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.

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 is not set in users' tokens.

The default Precedence value is null.

groupType_groupName :: Lens' GroupType (Maybe Text) Source #

The name of the group.

groupType_description :: Lens' GroupType (Maybe Text) Source #

A string containing the description of the group.

groupType_roleArn :: Lens' GroupType (Maybe Text) Source #

The role ARN for the group.