Class CfnIdentityPoolRoleAttachment
The AWS::Cognito::IdentityPoolRoleAttachment
resource manages the role configuration for an Amazon Cognito identity pool.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIdentityPoolRoleAttachment : CfnResource, IInspectable
Syntax (vb)
Public Class CfnIdentityPoolRoleAttachment Inherits CfnResource Implements IInspectable
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
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 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
});
Synopsis
Constructors
CfnIdentityPoolRoleAttachment(Construct, string, ICfnIdentityPoolRoleAttachmentProps) | The |
Properties
AttrId | The resource ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | The |
IdentityPoolId | An identity pool ID in the format |
RoleMappings | How users for a specific identity provider are mapped to roles. |
Roles | The map of the roles associated with this pool. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnIdentityPoolRoleAttachment(Construct, string, ICfnIdentityPoolRoleAttachmentProps)
The AWS::Cognito::IdentityPoolRoleAttachment
resource manages the role configuration for an Amazon Cognito identity pool.
public CfnIdentityPoolRoleAttachment(Construct scope, string id, ICfnIdentityPoolRoleAttachmentProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnIdentityPoolRoleAttachmentProps
Resource properties.
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated
Properties
AttrId
The resource ID.
public virtual string AttrId { get; }
Property Value
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::Cognito::IdentityPoolRoleAttachment
resource manages the role configuration for an Amazon Cognito identity pool.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated
IdentityPoolId
An identity pool ID in the format REGION:GUID
.
public virtual string IdentityPoolId { get; set; }
Property Value
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated
RoleMappings
How users for a specific identity provider are mapped to roles.
public virtual object? RoleMappings { get; set; }
Property Value
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated
Roles
The map of the roles associated with this pool.
public virtual object? Roles { get; set; }
Property Value
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated
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.
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::Cognito::IdentityPoolRoleAttachment
resource manages the role configuration for an Amazon Cognito identity pool.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::Cognito::IdentityPoolRoleAttachment
ExampleMetadata: fixture=_generated