Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

MappingRule - Amazon Cognito Federated Identities

MappingRule

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

Contents

Claim

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

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

The role ARN.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Value

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 AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.