Class CfnIdentityPoolRoleAttachment
A CloudFormation AWS::Cognito::IdentityPoolRoleAttachment
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class CfnIdentityPoolRoleAttachment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnIdentityPoolRoleAttachment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Cognito::IdentityPoolRoleAttachment
resource manages the role configuration for an Amazon Cognito identity pool.
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) | Create a new |
CfnIdentityPoolRoleAttachment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIdentityPoolRoleAttachment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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>) |
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 System.String
- scoped id of the resource.
- props ICfnIdentityPoolRoleAttachmentProps
- resource properties.
CfnIdentityPoolRoleAttachment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIdentityPoolRoleAttachment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIdentityPoolRoleAttachment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIdentityPoolRoleAttachment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
IdentityPoolId
An identity pool ID in the format REGION:GUID
.
public virtual string IdentityPoolId { get; set; }
Property Value
System.String
Remarks
RoleMappings
How users for a specific identity provider are mapped to roles.
public virtual object RoleMappings { get; set; }
Property Value
System.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 .
Roles
The map of the roles associated with this pool.
public virtual object Roles { get; set; }
Property Value
System.Object
Remarks
For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>