Skip to main content

ICognitoIdentityRoleMapping

Interface in AWS.CognitoIdentity

Interface for RoleMapping.

Properties​

AmbiguousRoleResolution​

property AmbiguousRoleResolution: string

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 their are multiple cognito:roles matches for the Token type.

Valid values:

  • AuthenticatedRole
  • Deny When Token or Rules as the &Type, AmbiguousRoleResolution is required.

RulesConfiguration​

property RulesConfiguration: ICognitoIdentityRulesConfigurationType

Type: ICognitoIdentityRulesConfigurationType

The rules to be used for mapping users to roles.

When Rules is set as the &Type, RulesConfiguration is required.

Type​

property Type: string

The role mapping type.

Valid values:

  • Token
  • Rules Setting Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. When setting Rules, an attempt to match claims from the token to map to a role will be made.