Skip to content

MappingRule

Source code in docs_src/capo_cognito_identity/types/mapping_rule.py
class MappingRule(TypedDict, closed=True):
    claim: "capo_cognito_identity.types.claim_name.ClaimName"
    """<p>The claim name that must be present in the token, for example, "isAdmin" or "paid".</p>"""
    match_type: (
        "capo_cognito_identity.types.mapping_rule_match_type.MappingRuleMatchType"
    )
    """<p>The match condition that specifies how closely the claim value in the IdP token must match <code>Value</code>.</p>"""
    value: "capo_cognito_identity.types.claim_value.ClaimValue"
    """<p>A brief string that the claim must match, for example, "paid" or "yes".</p>"""
    role_arn: "capo_cognito_identity.types.arn_string.ARNString"
    """<p>The role ARN.</p>"""

claim instance-attribute

claim: ClaimName

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: ARNString

The role ARN.

value instance-attribute

value: ClaimValue

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