interface MappingRuleProperty

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty
Java	software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty
Python	aws_cdk.aws_cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty
TypeScript	@aws-cdk/aws-cognito » CfnIdentityPoolRoleAttachment » MappingRuleProperty

Defines how to map a claim to a role ARN.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';
const mappingRuleProperty: cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty = {
  claim: 'claim',
  matchType: 'matchType',
  roleArn: 'roleArn',
  value: 'value',
};

Properties

Name	Type	Description
claim	string	The claim name that must be present in the token.
matchType	string	The match condition that specifies how closely the claim value in the IdP token must match Value .
roleArn	string	The Amazon Resource Name (ARN) of the role.
value	string	A brief string that the claim must match.

---

claim

Type: string

The claim name that must be present in the token.

For example: "isAdmin" or "paid".

---

matchType

Type: string

The match condition that specifies how closely the claim value in the IdP token must match Value .

Valid values are: Equals , Contains , StartsWith , and NotEqual .

---

roleArn

Type: string

The Amazon Resource Name (ARN) of the role.

---

value

Type: string

A brief string that the claim must match.

For example, "paid" or "yes".