Interface IIdentityPoolRoleMapping

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

Namespace: Amazon.CDK.AWS.Cognito.IdentityPool.Alpha

Assembly: Amazon.CDK.AWS.Cognito.IdentityPool.Alpha.dll

Syntax (csharp)

public interface IIdentityPoolRoleMapping

Syntax (vb)

Public Interface 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.Alpha;

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


identityPool.AddRoleMappings(myAddedRoleMapping1, myAddedRoleMapping2, myAddedRoleMapping3);

Synopsis

Properties

MappingKey	(experimental) The key used for the role mapping in the role mapping hash.
ProviderUrl	(experimental) The url of the Provider 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.

Properties

MappingKey

(experimental) The key used for the role mapping in the role mapping hash.

virtual string MappingKey { get; }

Property Value

System.String

Remarks

Required if the providerUrl is a token.

Default: - The provided providerUrl

Stability: Experimental

ProviderUrl

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

IdentityPoolProviderUrl ProviderUrl { get; }

Property Value

IdentityPoolProviderUrl

Remarks

Stability: Experimental

ResolveAmbiguousRoles

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

virtual Nullable<bool> ResolveAmbiguousRoles { get; }

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.

virtual IRoleMappingRule[] Rules { get; }

Property Value

IRoleMappingRule[]

Remarks

Required if useToken is false

Default: - No role 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.

virtual Nullable<bool> UseToken { get; }

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