CfnUserPoolUserToGroupAttachmentProps Struct
Properties for defining a CfnUserPoolUserToGroupAttachment.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cfnUserPoolUserToGroupAttachmentProps: cognito.CfnUserPoolUserToGroupAttachmentProps = {
groupName: 'groupName',
username: 'username',
userPoolId: 'userPoolId',
};
python
# 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"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnUserPoolUserToGroupAttachmentProps = new CfnUserPoolUserToGroupAttachmentProps {
GroupName = "groupName",
Username = "username",
UserPoolId = "userPoolId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnUserPoolUserToGroupAttachmentProps := &CfnUserPoolUserToGroupAttachmentProps{
GroupName: jsii.String("groupName"),
Username: jsii.String("username"),
UserPoolId: jsii.String("userPoolId"),
}
Properties
groupNamestring | IUserPoolGroupRefgroup_nametyping.Union[str, IUserPoolGroupRef]groupNameStringGroupNamestringGroupNameinterface{}required#The name of the group that you want to add your user to.
usernamestring | IUserPoolUserRefusernametyping.Union[str, IUserPoolUserRef]usernameStringUsernamestringUsernameinterface{}required#The user's username.
userPoolIdstring | IUserPoolRefuser_pool_idtyping.Union[str, IUserPoolRef]userPoolIdStringUserPoolIdstringUserPoolIdinterface{}required#The ID of the user pool that contains the group that you want to add the user to.