Interface ICfnIdentityPoolRoleAttachmentProps

Properties for defining a CfnIdentityPoolRoleAttachment.

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnIdentityPoolRoleAttachmentProps

Syntax (vb)

Public Interface ICfnIdentityPoolRoleAttachmentProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.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 roles;

             var cfnIdentityPoolRoleAttachmentProps = new CfnIdentityPoolRoleAttachmentProps {
                 IdentityPoolId = "identityPoolId",

                 // the properties below are optional
                 RoleMappings = new Dictionary<string, object> {
                     { "roleMappingsKey", 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"
                             } }
                         }
                     } }
                 },
                 Roles = roles
             };

Synopsis

Properties

IdentityPoolId	An identity pool ID in the format REGION:GUID .
RoleMappings	How users for a specific identity provider are mapped to roles.
Roles	The map of the roles associated with this pool.

Properties

IdentityPoolId

An identity pool ID in the format REGION:GUID .

object IdentityPoolId { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-identitypoolid

Type union: either string or IIdentityPoolRef

RoleMappings

How users for a specific identity provider are mapped to roles.

object? RoleMappings { get; }

Property Value

object

Remarks

This is a string to the RoleMapping object map. The string identifies the identity provider. For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id .

If the IdentityProvider field isn't provided in this object, the string is used as the identity provider name.

For more information, see the RoleMapping property .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-rolemappings

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnIdentityPoolRoleAttachment.IRoleMappingProperty>

Roles

The map of the roles associated with this pool.

object? Roles { get; }

Property Value

object

Remarks

For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-roles