Amazonka.CognitoIdentity.Types.RoleMapping

Documentation

data RoleMapping

A role mapping.

See: newRoleMapping smart constructor.

Constructors

RoleMapping'

Fields

• ambiguousRoleResolution :: Maybe AmbiguousRoleResolutionType

  If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

  Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

• rulesConfiguration :: Maybe RulesConfigurationType

  The rules to be used for mapping users to roles.

  If you specify Rules as the role mapping type, RulesConfiguration is required.

• type' :: RoleMappingType

  The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Instances

FromJSON RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

parseJSON :: Value -> Parser RoleMapping

parseJSONList :: Value -> Parser [RoleMapping]

ToJSON RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

toJSON :: RoleMapping -> Value

toEncoding :: RoleMapping -> Encoding

toJSONList :: [RoleMapping] -> Value

toEncodingList :: [RoleMapping] -> Encoding

Generic RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Associated Types

type Rep RoleMapping :: Type -> Type

Methods

from :: RoleMapping -> Rep RoleMapping x

to :: Rep RoleMapping x -> RoleMapping

Read RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

readsPrec :: Int -> ReadS RoleMapping

readList :: ReadS [RoleMapping]

readPrec :: ReadPrec RoleMapping

readListPrec :: ReadPrec [RoleMapping]

Show RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

showsPrec :: Int -> RoleMapping -> ShowS

show :: RoleMapping -> String

showList :: [RoleMapping] -> ShowS

NFData RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

rnf :: RoleMapping -> ()

Eq RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

(==) :: RoleMapping -> RoleMapping -> Bool

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

Hashable RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

hashWithSalt :: Int -> RoleMapping -> Int

hash :: RoleMapping -> Int

type Rep RoleMapping

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

type Rep RoleMapping = D1 ('MetaData "RoleMapping" "Amazonka.CognitoIdentity.Types.RoleMapping" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "RoleMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ambiguousRoleResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmbiguousRoleResolutionType)) :*: (S1 ('MetaSel ('Just "rulesConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RulesConfigurationType)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RoleMappingType))))

newRoleMapping

Arguments

:: RoleMappingType

$sel:type':RoleMapping'

-> RoleMapping

Create a value of RoleMapping 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:ambiguousRoleResolution:RoleMapping', roleMapping_ambiguousRoleResolution - If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

$sel:rulesConfiguration:RoleMapping', roleMapping_rulesConfiguration - The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

$sel:type':RoleMapping', roleMapping_type - The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

roleMapping_ambiguousRoleResolution :: Lens' RoleMapping (Maybe AmbiguousRoleResolutionType)

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

roleMapping_rulesConfiguration :: Lens' RoleMapping (Maybe RulesConfigurationType)

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

roleMapping_type :: Lens' RoleMapping RoleMappingType

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.