interface MappingRuleProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnIdentityPoolRoleAttachmentPropsMixin.MappingRuleProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnIdentityPoolRoleAttachmentPropsMixin_MappingRuleProperty
Java	software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnIdentityPoolRoleAttachmentPropsMixin.MappingRuleProperty
Python	aws_cdk.mixins_preview.aws_cognito.mixins.CfnIdentityPoolRoleAttachmentPropsMixin.MappingRuleProperty
TypeScript	@aws-cdk/mixins-preview » aws_cognito » mixins » CfnIdentityPoolRoleAttachmentPropsMixin » MappingRuleProperty

Defines how to map a claim to a role ARN.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';
const mappingRuleProperty: cognito_mixins.CfnIdentityPoolRoleAttachmentPropsMixin.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 (optional)

The claim name that must be present in the token.

For example: "isAdmin" or "paid".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim

---

matchType?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype

---

roleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the role.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn

---

value?

Type: string (optional)

A brief string that the claim must match.

For example, "paid" or "yes".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value