Interface CfnIdentityPoolRoleAttachment.IMappingRuleProperty

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Defines how to map a claim to a role ARN.

public interface CfnIdentityPoolRoleAttachment.IMappingRuleProperty

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Cognito;

             var mappingRuleProperty = new MappingRuleProperty {
                 Claim = "claim",
                 MatchType = "matchType",
                 RoleArn = "roleArn",
                 Value = "value"
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

Claim

The claim name that must be present in the token.

string Claim { get; }

Property Value

string

Remarks

For example: "isAdmin" or "paid".

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

MatchType

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

string MatchType { get; }

Property Value

string

Remarks

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

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

RoleArn

The Amazon Resource Name (ARN) of the role.

string RoleArn { get; }

Property Value

string

Remarks

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

Value

A brief string that the claim must match.

string Value { get; }

Property Value

string

Remarks

For example, "paid" or "yes".

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