CfnUserPoolUserToGroupAttachmentMixinProps

class aws_cdk.cfn_property_mixins.aws_cognito.CfnUserPoolUserToGroupAttachmentMixinProps(*, group_name=None, username=None, user_pool_id=None)

Bases: object

Properties for CfnUserPoolUserToGroupAttachmentPropsMixin.

Parameters:

group_name (Union[str, IUserPoolGroupRef, None]) – The name of the group that you want to add your user to.
username (Union[str, IUserPoolUserRef, None]) – The user’s username.
user_pool_id (Union[str, IUserPoolRef, None]) – The ID of the user pool that contains the group that you want to add the user to.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_cognito as cognito

cfn_user_pool_user_to_group_attachment_mixin_props = cognito.CfnUserPoolUserToGroupAttachmentMixinProps(
    group_name="groupName",
    username="username",
    user_pool_id="userPoolId"
)

Attributes

group_name

The name of the group that you want to add your user to.

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

user_pool_id

The ID of the user pool that contains the group that you want to add the user to.

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

username

The user’s username.

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