Class RoleMappingRule
(experimental) Represents an Identity Pool Role Attachment Role Mapping Rule.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cognito.IdentityPool
Assembly: Amazon.CDK.AWS.Cognito.IdentityPool.dll
Syntax (csharp)
public class RoleMappingRule : Object, IRoleMappingRule
Syntax (vb)
Public Class RoleMappingRule
Inherits Object
Implements IRoleMappingRule
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
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.IdentityPool;
using Amazon.CDK.AWS.IAM;
Role role;
var roleMappingRule = new RoleMappingRule {
Claim = "claim",
ClaimValue = "claimValue",
MappedRole = role,
// the properties below are optional
MatchType = RoleMappingMatchType.EQUALS
};
Synopsis
Constructors
RoleMappingRule() |
Properties
Claim | (experimental) The key sent in the token by the federated identity provider. |
ClaimValue | (experimental) The value of the claim that must be matched. |
MappedRole | (experimental) The Role to be assumed when Claim Value is matched. |
MatchType | (experimental) How to match with the Claim value. |
Constructors
RoleMappingRule()
public RoleMappingRule()
Properties
Claim
(experimental) The key sent in the token by the federated identity provider.
public string Claim { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
ClaimValue
(experimental) The value of the claim that must be matched.
public string ClaimValue { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
MappedRole
(experimental) The Role to be assumed when Claim Value is matched.
public IRole MappedRole { get; set; }
Property Value
Remarks
Stability: Experimental
MatchType
(experimental) How to match with the Claim value.
public Nullable<RoleMappingMatchType> MatchType { get; set; }
Property Value
System.Nullable<RoleMappingMatchType>
Remarks
Default: RoleMappingMatchType.EQUALS
Stability: Experimental