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.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.384Z")
@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()
String	getGroupName()	The name of the group that you want to add your user to.
String	getUsername()	The user's username.
String	getUserPoolId()	The user pool ID for the user pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroupName

@Stability(Stable)
@NotNull
String getGroupName()

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

See Also:

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

getUsername

@Stability(Stable)
@NotNull
String getUsername()

The user's username.

See Also:

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

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The user pool ID for the user pool.

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