aws-cdk-lib.aws_cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty

interface MappingRuleProperty

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnIdentityPoolRoleAttachment_MappingRuleProperty
Javasoftware.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty
Pythonaws_cdk.aws_cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty
TypeScript aws-cdk-lib » 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 { aws_cognito as cognito } from 'aws-cdk-lib';
const mappingRuleProperty: cognito.CfnIdentityPoolRoleAttachment.MappingRuleProperty = {
  claim: 'claim',
  matchType: 'matchType',
  roleArn: 'roleArn',
  value: 'value',
};

Properties

NameTypeDescription
claimstringThe claim name that must be present in the token.
matchTypestringThe match condition that specifies how closely the claim value in the IdP token must match Value .
roleArnstringThe Amazon Resource Name (ARN) of the role.
valuestringA 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".