Class CfnIdentityPoolRoleAttachment.RoleMappingProperty

One of a set of RoleMappings , a property of the AWS::Cognito::IdentityPoolRoleAttachment resource that defines the role-mapping attributes of an Amazon Cognito identity pool.

Inheritance

object

CfnIdentityPoolRoleAttachment.RoleMappingProperty

Implements

CfnIdentityPoolRoleAttachment.IRoleMappingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIdentityPoolRoleAttachment.RoleMappingProperty : CfnIdentityPoolRoleAttachment.IRoleMappingProperty

Syntax (vb)

Public Class CfnIdentityPoolRoleAttachment.RoleMappingProperty Implements CfnIdentityPoolRoleAttachment.IRoleMappingProperty

Remarks

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

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;

             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"
                     } }
                 }
             };

Synopsis

Constructors

RoleMappingProperty()

One of a set of RoleMappings , a property of the AWS::Cognito::IdentityPoolRoleAttachment resource that defines the role-mapping attributes of an Amazon Cognito identity pool.

Properties

AmbiguousRoleResolution	If you specify Token or Rules as the Type , AmbiguousRoleResolution is required.
IdentityProvider	Identifier for the identity provider for which the role is mapped.
RulesConfiguration	The rules to be used for mapping users to roles.
Type	The role mapping type.

Constructors

RoleMappingProperty()

One of a set of RoleMappings , a property of the AWS::Cognito::IdentityPoolRoleAttachment resource that defines the role-mapping attributes of an Amazon Cognito identity pool.

public RoleMappingProperty()

Remarks

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

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;

             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"
                     } }
                 }
             };

Properties

AmbiguousRoleResolution

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

public string? AmbiguousRoleResolution { get; set; }

Property Value

string

Remarks

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.

See: 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.

public string? IdentityProvider { get; set; }

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.

See: 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.

public object? RulesConfiguration { get; set; }

Property Value

object

Remarks

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

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

Type

The role mapping type.

public string Type { get; set; }

Property Value

string

Remarks

Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

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

Implements

CfnIdentityPoolRoleAttachment.IRoleMappingProperty