Interface CfnIdentityPoolRoleAttachment.IRoleMappingProperty

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

RoleMapping is a property of the AWS::Cognito::IdentityPoolRoleAttachment resource that defines the role-mapping attributes of an Amazon Cognito identity pool.

public interface CfnIdentityPoolRoleAttachment.IRoleMappingProperty

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 roleMappingProperty = new RoleMappingProperty {
                 Type = "type",

                 // the properties below are optional
                 AmbiguousRoleResolution = "ambiguousRoleResolution",
                 IdentityProvider = "identityProvider",
                 RulesConfiguration = new RulesConfigurationTypeProperty {
                     Rules = new [] { new MappingRuleProperty {
                         Claim = "claim",
                         MatchType = "matchType",
                         RoleArn = "roleArn",
                         Value = "value"
                     } }
                 }
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

AmbiguousRoleResolution

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

string? AmbiguousRoleResolution { get; }

Property Value

string

Remarks

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Valid values are AuthenticatedRole or Deny .

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

IdentityProvider

Identifier for the identity provider for which the role is mapped.

string? IdentityProvider { get; }

Property Value

string

Remarks

For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id (http://cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id) . This is the identity provider that is used by the user for authentication.

If the identity provider property isn't provided, the key of the entry in the RoleMappings map is used as the identity provider.

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

RulesConfiguration

The rules to be used for mapping users to roles.

object? RulesConfiguration { get; }

Property Value

object

Remarks

If you specify "Rules" as the role-mapping type, RulesConfiguration is required.

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

Type

The role-mapping type.

string Type { get; }

Property Value

string

Remarks

Token uses cognito:roles and cognito:preferred_role claims from the Amazon Cognito identity provider token to map groups to roles. Rules attempts to match claims from the token to map to a role.

Valid values are Token or Rules .

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