Class IdentityPoolRoleMapping

(experimental) Map roles to users in the identity pool based on claims from the Identity Provider.

Inheritance
System.Object
IdentityPoolRoleMapping
Namespace: Amazon.CDK.AWS.Cognito.IdentityPool
Assembly: Amazon.CDK.AWS.Cognito.IdentityPool.dll
Syntax (csharp)
public class IdentityPoolRoleMapping : Object, IIdentityPoolRoleMapping
Syntax (vb)
Public Class IdentityPoolRoleMapping
    Inherits Object
    Implements IIdentityPoolRoleMapping
Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Cognito.IdentityPool;

IdentityPool identityPool;
IdentityPoolRoleMapping myAddedRoleMapping1;
IdentityPoolRoleMapping myAddedRoleMapping2;
IdentityPoolRoleMapping myAddedRoleMapping3;


identityPool.AddRoleMappings(myAddedRoleMapping1, myAddedRoleMapping2, myAddedRoleMapping3);

Synopsis

Constructors

IdentityPoolRoleMapping()

Properties

ProviderUrl

(experimental) The url of the provider of for which the role is mapped.
ResolveAmbiguousRoles

(experimental) Allow for role assumption when results of role mapping are ambiguous.
Rules

(experimental) The claim and value that must be matched in order to assume the role.
UseToken

(experimental) If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from identity provider.

Constructors

IdentityPoolRoleMapping()

public IdentityPoolRoleMapping()

Properties

ProviderUrl

(experimental) The url of the provider of for which the role is mapped.

public IdentityPoolProviderUrl ProviderUrl { get; set; }
Property Value

IdentityPoolProviderUrl

Remarks

Stability: Experimental

ResolveAmbiguousRoles

(experimental) Allow for role assumption when results of role mapping are ambiguous.

public Nullable<bool> ResolveAmbiguousRoles { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false - Ambiguous role resolutions will lead to requester being denied

Stability: Experimental

Rules

(experimental) The claim and value that must be matched in order to assume the role.

public IRoleMappingRule[] Rules { get; set; }
Property Value

IRoleMappingRule[]

Remarks

Required if useToken is false

Default: - No Rule Mapping Rule

Stability: Experimental

UseToken

(experimental) If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from identity provider.

public Nullable<bool> UseToken { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Stability: Experimental

See: https://docs.aws.amazon.com/cognito/latest/developerguide/role-based-access-control.html#using-tokens-to-assign-roles-to-users

Implements