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.CognitoIdentity.Types.MappingRule

Description

Synopsis

data MappingRule = MappingRule' {
- claim :: Text
- matchType :: MappingRuleMatchType
- value :: Text
- roleARN :: Text
}
newMappingRule :: Text -> MappingRuleMatchType -> Text -> Text -> MappingRule
mappingRule_claim :: Lens' MappingRule Text
mappingRule_matchType :: Lens' MappingRule MappingRuleMatchType
mappingRule_value :: Lens' MappingRule Text
mappingRule_roleARN :: Lens' MappingRule Text

Documentation

data MappingRule Source #

A rule that maps a claim name, a claim value, and a match type to a role ARN.

See: newMappingRule smart constructor.

Constructors

MappingRule'
Fields claim :: Text The claim name that must be present in the token, for example, "isAdmin" or "paid". matchType :: MappingRuleMatchType The match condition that specifies how closely the claim value in the IdP token must match `Value`. value :: Text A brief string that the claim must match, for example, "paid" or "yes". roleARN :: Text The role ARN.

Instances

Instances details

Eq MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Methods (==) :: MappingRule -> MappingRule -> Bool # (/=) :: MappingRule -> MappingRule -> Bool #
Read MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Methods readsPrec :: Int -> ReadS MappingRule # readList :: ReadS [MappingRule] # readPrec :: ReadPrec MappingRule # readListPrec :: ReadPrec [MappingRule] #
Show MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Methods showsPrec :: Int -> MappingRule -> ShowS # show :: MappingRule -> String # showList :: [MappingRule] -> ShowS #
Generic MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Associated Types type Rep MappingRule :: Type -> Type # Methods from :: MappingRule -> Rep MappingRule x # to :: Rep MappingRule x -> MappingRule #
NFData MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Methods rnf :: MappingRule -> () #
Hashable MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Methods hashWithSalt :: Int -> MappingRule -> Int # hash :: MappingRule -> Int #
ToJSON MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Methods toJSON :: MappingRule -> Value # toEncoding :: MappingRule -> Encoding # toJSONList :: [MappingRule] -> Value # toEncodingList :: [MappingRule] -> Encoding #
FromJSON MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule Methods parseJSON :: Value -> Parser MappingRule # parseJSONList :: Value -> Parser [MappingRule] #
type Rep MappingRule Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.MappingRule type Rep MappingRule = D1 ('MetaData "MappingRule" "Amazonka.CognitoIdentity.Types.MappingRule" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "MappingRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "claim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "matchType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MappingRuleMatchType)) :: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMappingRule Source #

Arguments

:: Text	`$sel:claim:MappingRule'`
-> MappingRuleMatchType	`$sel:matchType:MappingRule'`
-> Text	`$sel:value:MappingRule'`
-> Text	`$sel:roleARN:MappingRule'`
-> MappingRule

Create a value of MappingRule 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:claim:MappingRule', mappingRule_claim - The claim name that must be present in the token, for example, "isAdmin" or "paid".

$sel:matchType:MappingRule', mappingRule_matchType - The match condition that specifies how closely the claim value in the IdP token must match Value.

$sel:value:MappingRule', mappingRule_value - A brief string that the claim must match, for example, "paid" or "yes".

$sel:roleARN:MappingRule', mappingRule_roleARN - The role ARN.

mappingRule_claim :: Lens' MappingRule Text Source #

The claim name that must be present in the token, for example, "isAdmin" or "paid".

mappingRule_matchType :: Lens' MappingRule MappingRuleMatchType Source #

The match condition that specifies how closely the claim value in the IdP token must match Value.

mappingRule_value :: Lens' MappingRule Text Source #

A brief string that the claim must match, for example, "paid" or "yes".

mappingRule_roleARN :: Lens' MappingRule Text Source #

The role ARN.