Package software.amazon.awscdk.services.cognito

Interface UserPoolGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolGroupOptions

All Known Implementing Classes:

UserPoolGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:51:54.565Z")
@Stability(Stable)
public interface UserPoolGroupProps
extends software.amazon.jsii.JsiiSerializable, UserPoolGroupOptions

Props for UserPoolGroup construct.

Example:

 UserPool userPool;
 Role role;
 UserPoolGroup.Builder.create(this, "UserPoolGroup")
         .userPool(userPool)
         .groupName("my-group-name")
         .precedence(1)
         .role(role)
         .build();
 // You can also add a group by using addGroup method.
 userPool.addGroup("AnotherUserPoolGroup", UserPoolGroupOptions.builder()
         .groupName("another-group-name")
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserPoolGroupProps.Builder	builder()
IUserPool	getUserPool()	The user pool to which this group is associated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolGroupOptions

getDescription, getGroupName, getPrecedence, getRole

Method Details

getUserPool

@Stability(Stable)
@NotNull
IUserPool getUserPool()

The user pool to which this group is associated.

builder

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

Returns:

a UserPoolGroupProps.Builder of UserPoolGroupProps