CfnUserPoolUserToGroupAttachmentProps

class aws_cdk.aws_cognito.CfnUserPoolUserToGroupAttachmentProps(*, group_name, username, user_pool_id)

Bases: object

Properties for defining a CfnUserPoolUserToGroupAttachment.

Parameters:

  • group_name (str) – The name of the group that you want to add your user to.

  • username (str) –

  • user_pool_id (str) – The user pool ID for the user pool.

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 import aws_cognito as cognito

cfn_user_pool_user_to_group_attachment_props = cognito.CfnUserPoolUserToGroupAttachmentProps(
    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 user pool ID for the user pool.

See:

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

username

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

Type:

see