Class CfnUserPoolUserToGroupAttachment

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::UserPoolUserToGroupAttachment.

public class CfnUserPoolUserToGroupAttachment : CfnResource, IInspectable

Inheritance

object

CfnUserPoolUserToGroupAttachment

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 cfnUserPoolUserToGroupAttachment = new CfnUserPoolUserToGroupAttachment(this, "MyCfnUserPoolUserToGroupAttachment", new CfnUserPoolUserToGroupAttachmentProps {
                 GroupName = "groupName",
                 Username = "username",
                 UserPoolId = "userPoolId"
             });

Remarks

Adds the specified user to the specified group.

Calling this action requires developer credentials.

CloudformationResource: AWS::Cognito::UserPoolUserToGroupAttachment

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolUserToGroupAttachment(Construct, string, ICfnUserPoolUserToGroupAttachmentProps)

Create a new AWS::Cognito::UserPoolUserToGroupAttachment.

public CfnUserPoolUserToGroupAttachment(Construct scope, string id, ICfnUserPoolUserToGroupAttachmentProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

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

string

CfnProperties

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

Property Value

IDictionary<string, object>

GroupName

The group name.

public virtual string GroupName { get; set; }

Property Value

string

Remarks

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

UserPoolId

The user pool ID for the user pool.

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

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

Username

The username for the user.

public virtual string Username { get; set; }

Property Value

string

Remarks

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

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>