libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentity.Types.RoleMapping

Description

 
Synopsis

Documentation

data RoleMapping Source #

A role mapping.

See: newRoleMapping smart constructor.

Constructors

RoleMapping' 

Fields

  • 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.

  • 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.

  • 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

Instances details
Eq RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Read RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Show RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Generic RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Associated Types

type Rep RoleMapping :: Type -> Type #

NFData RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

Methods

rnf :: RoleMapping -> () #

Hashable RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

ToJSON RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

FromJSON RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

type Rep RoleMapping Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.RoleMapping

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

newRoleMapping Source #

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: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: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: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_rulesConfiguration :: Lens' RoleMapping (Maybe RulesConfigurationType) Source #

The rules to be used for mapping users to roles.

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

roleMapping_ambiguousRoleResolution :: Lens' RoleMapping (Maybe AmbiguousRoleResolutionType) Source #

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_type :: Lens' RoleMapping RoleMappingType Source #

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.