# MappingRule


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

## Contents


 ** Claim **   <a name="CognitoIdentity-Type-MappingRule-Claim"></a>
The claim name that must be present in the token, for example, "isAdmin" or "paid".  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}]+`   
Required: Yes

 ** MatchType **   <a name="CognitoIdentity-Type-MappingRule-MatchType"></a>
The match condition that specifies how closely the claim value in the IdP token must match `Value`.  
Type: String  
Valid Values: `Equals | Contains | StartsWith | NotEqual`   
Required: Yes

 ** RoleARN **   <a name="CognitoIdentity-Type-MappingRule-RoleARN"></a>
The role ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: Yes

 ** Value **   <a name="CognitoIdentity-Type-MappingRule-Value"></a>
A brief string that the claim must match, for example, "paid" or "yes".  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/cognito-identity-2014-06-30/MappingRule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/cognito-identity-2014-06-30/MappingRule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/cognito-identity-2014-06-30/MappingRule)