Package software.amazon.awscdk.services.cognito

Class UserPoolGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.UserPoolGroup

All Implemented Interfaces:

IEnvironmentAware, IResource, IUserPoolGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:01.613Z")
@Stability(Stable)
public class UserPoolGroup
extends Resource
implements IUserPoolGroup

Define a user pool group.

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	Class	Description
static final class	UserPoolGroup.Builder	A fluent builder for UserPoolGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolGroup

IUserPoolGroup.Jsii$Default, IUserPoolGroup.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserPoolGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolGroup(software.amazon.jsii.JsiiObjectRef objRef)
	UserPoolGroup(software.constructs.Construct scope, String id, UserPoolGroupProps props)

Method Summary

Modifier and Type	Method	Description
static IUserPoolGroup	fromGroupName(software.constructs.Construct scope, String id, String groupName)	Import a UserPoolGroup given its group name.
String	getGroupName()	The user group name.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

UserPoolGroup

protected UserPoolGroup(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolGroup

protected UserPoolGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolGroup

@Stability(Stable)
public UserPoolGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 UserPoolGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromGroupName

@Stability(Stable)
@NotNull
public static IUserPoolGroup fromGroupName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String groupName)

Import a UserPoolGroup given its group name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

groupName - This parameter is required.

getGroupName

@Stability(Stable)
@NotNull
public String getGroupName()

The user group name.

Specified by:

getGroupName in interface IUserPoolGroup