Class CfnIdentityPoolRoleAttachment

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::IdentityPoolRoleAttachment.

public class CfnIdentityPoolRoleAttachment : CfnResource, IInspectable

Inheritance

object

CfnIdentityPoolRoleAttachment

Implements

IInspectable

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 cfnIdentityPoolRoleAttachment = new CfnIdentityPoolRoleAttachment(this, "MyCfnIdentityPoolRoleAttachment", 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
             });

Remarks

The AWS::Cognito::IdentityPoolRoleAttachment resource manages the role configuration for an Amazon Cognito identity pool.

CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment

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

ExampleMetadata: fixture=_generated

Constructors

CfnIdentityPoolRoleAttachment(Construct, string, ICfnIdentityPoolRoleAttachmentProps)

Create a new AWS::Cognito::IdentityPoolRoleAttachment.

public CfnIdentityPoolRoleAttachment(Construct scope, string id, ICfnIdentityPoolRoleAttachmentProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnIdentityPoolRoleAttachmentProps

• resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

IdentityPoolId

An identity pool ID in the format REGION:GUID .

public virtual string IdentityPoolId { get; set; }

Property Value

string

Remarks

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

RoleMappings

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

public virtual object? RoleMappings { get; set; }

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 .

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

Roles

The map of the roles associated with this pool.

public virtual object Roles { get; set; }

Property Value

object

Remarks

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

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>