Menu
Amazon Cognito Federated Identities
API Reference (API Version 2014-06-30)

RoleMapping

A role mapping.

Contents

AmbiguousRoleResolution

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.

Type: String

Valid Values: AuthenticatedRole | Deny

Required: No

RulesConfiguration

The rules to be used for mapping users to roles.

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

Type: RulesConfigurationType object

Required: No

Type

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.

Type: String

Valid Values: Token | Rules

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: