Class CfnUserPoolUserToGroupAttachment
Adds a user to a group.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserPoolUserToGroupAttachment : CfnResource, IInspectable
Syntax (vb)
Public Class CfnUserPoolUserToGroupAttachment
Inherits CfnResource
Implements IInspectable
Remarks
A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups
claim to their access and identity tokens.
Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more - Signing AWS API Requests
CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment
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 cfnUserPoolUserToGroupAttachment = new CfnUserPoolUserToGroupAttachment(this, "MyCfnUserPoolUserToGroupAttachment", new CfnUserPoolUserToGroupAttachmentProps {
GroupName = "groupName",
Username = "username",
UserPoolId = "userPoolId"
});
Synopsis
Constructors
CfnUserPoolUserToGroupAttachment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserPoolUserToGroupAttachment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnUserPoolUserToGroupAttachment(Construct, String, ICfnUserPoolUserToGroupAttachmentProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
GroupName | The name of the group that you want to add your user to. |
Username | The user's username. |
UserPoolId | The user pool ID for the user pool. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUserPoolUserToGroupAttachment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserPoolUserToGroupAttachment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserPoolUserToGroupAttachment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserPoolUserToGroupAttachment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnUserPoolUserToGroupAttachment(Construct, String, ICfnUserPoolUserToGroupAttachmentProps)
public CfnUserPoolUserToGroupAttachment(Construct scope, string id, ICfnUserPoolUserToGroupAttachmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnUserPoolUserToGroupAttachmentProps
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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
GroupName
The name of the group that you want to add your user to.
public virtual string GroupName { get; set; }
Property Value
System.String
Username
The user's username.
public virtual string Username { get; set; }
Property Value
System.String
UserPoolId
The user pool ID for the user pool.
public virtual string UserPoolId { get; set; }
Property Value
System.String
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>