Skip to content

Cognito Identity  >  Structures  >  RoleMapping

RoleMapping

Structure Class

RoleMapping dataclass

A role mapping.

Attributes

ambiguous_role_resolution class-attribute instance-attribute 
ambiguous_role_resolution: AmbiguousRoleResolutionType | None = None

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.

rules_configuration class-attribute instance-attribute 
rules_configuration: RulesConfigurationType | None = None

The rules to be used for mapping users to roles.

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

type instance-attribute 
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.