interface IdentityPoolRoleMapping 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.IdentityPool.IdentityPoolRoleMapping`
Java	`software.amazon.awscdk.services.cognito.identitypool.IdentityPoolRoleMapping`
Python	`aws_cdk.aws_cognito_identitypool.IdentityPoolRoleMapping`
TypeScript (source)	`@aws-cdk/aws-cognito-identitypool` » `IdentityPoolRoleMapping`

Map roles to users in the identity pool based on claims from the Identity Provider.

Example

import { IdentityPoolRoleMapping } from '@aws-cdk/aws-cognito-identitypool';

declare const identityPool: IdentityPool;
declare const myAddedRoleMapping1: IdentityPoolRoleMapping;
declare const myAddedRoleMapping2: IdentityPoolRoleMapping;
declare const myAddedRoleMapping3: IdentityPoolRoleMapping;

identityPool.addRoleMappings(myAddedRoleMapping1, myAddedRoleMapping2, myAddedRoleMapping3);

Properties

Name	Type	Description
providerUrl🔹	`IdentityPoolProviderUrl`	The url of the provider of for which the role is mapped.
resolveAmbiguousRoles?🔹	`boolean`	Allow for role assumption when results of role mapping are ambiguous.
rules?🔹	`RoleMappingRule[]`	The claim and value that must be matched in order to assume the role.
useToken?🔹	`boolean`	If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from identity provider.

providerUrl🔹

Type: IdentityPoolProviderUrl

The url of the provider of for which the role is mapped.

resolveAmbiguousRoles?🔹

Type: boolean (optional, default: false - Ambiguous role resolutions will lead to requester being denied)

Allow for role assumption when results of role mapping are ambiguous.

rules?🔹

Type: RoleMappingRule[] (optional, default: No Rule Mapping Rule)

The claim and value that must be matched in order to assume the role.

Required if useToken is false

useToken?🔹

Type: boolean (optional, default: false)

If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from identity provider.