Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolUserToGroupAttachmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolUserToGroupAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:07.473Z")
@Stability(Stable)
public interface CfnUserPoolUserToGroupAttachmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolUserToGroupAttachment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolUserToGroupAttachmentProps cfnUserPoolUserToGroupAttachmentProps = CfnUserPoolUserToGroupAttachmentProps.builder()
         .groupName("groupName")
         .username("username")
         .userPoolId("userPoolId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolUserToGroupAttachmentProps.Builder	A builder for CfnUserPoolUserToGroupAttachmentProps
static final class	CfnUserPoolUserToGroupAttachmentProps.Jsii$Proxy	An implementation for CfnUserPoolUserToGroupAttachmentProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolUserToGroupAttachmentProps.Builder	builder()
Object	getGroupName()	The name of the group that you want to add your user to.
Object	getUsername()	The user's username.
Object	getUserPoolId()	The ID of the user pool that contains the group that you want to add the user to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroupName

@Stability(Stable)
@NotNull
Object getGroupName()

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

Returns union: either String or IUserPoolGroupRef

See Also:

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

getUsername

@Stability(Stable)
@NotNull
Object getUsername()

The user's username.

Returns union: either String or IUserPoolUserRef

See Also:

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

getUserPoolId

@Stability(Stable)
@NotNull
Object getUserPoolId()

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

Returns union: either String or IUserPoolRef

See Also:

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

builder

@Stability(Stable)
static CfnUserPoolUserToGroupAttachmentProps.Builder builder()

Returns:

a CfnUserPoolUserToGroupAttachmentProps.Builder of CfnUserPoolUserToGroupAttachmentProps