Skip to content

Cognito Identity  >  Structures  >  MappingRule

MappingRule

Structure Class

MappingRule dataclass

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

Attributes

claim instance-attribute
claim: str

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

match_type instance-attribute

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

role_arn instance-attribute
role_arn: str

The role ARN.

value instance-attribute
value: str

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