Class CfnUserPoolUserToGroupAttachment

A CloudFormation AWS::Cognito::UserPoolUserToGroupAttachment.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnUserPoolUserToGroupAttachment
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class CfnUserPoolUserToGroupAttachment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUserPoolUserToGroupAttachment
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
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

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(Construct, String, ICfnUserPoolUserToGroupAttachmentProps)

Create a new AWS::Cognito::UserPoolUserToGroupAttachment.
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

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
GroupName

The group name.
Username

The username for the user.
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(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 System.String
  • scoped id of the resource.
props ICfnUserPoolUserToGroupAttachmentProps
  • resource properties.

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

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 group name.

public virtual string GroupName { get; set; }
Property Value

System.String

Remarks

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

Username

The username for the user.

public virtual string Username { get; set; }
Property Value

System.String

Remarks

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

UserPoolId

The user pool ID for the user pool.

public virtual string UserPoolId { get; set; }
Property Value

System.String

Remarks

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

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>

Overrides

Implements

Constructs.IConstruct