Package software.amazon.awscdk.services.cognito

Interface IUserPool

All Superinterfaces:

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

All Known Subinterfaces:

IUserPool.Jsii$Default

All Known Implementing Classes:

IUserPool.Jsii$Proxy, UserPool

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:03:51.530Z")
@Stability(Stable)
public interface IUserPool
extends software.amazon.jsii.JsiiSerializable, IResource, IUserPoolRef

Represents a Cognito UserPool.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IUserPool.Jsii$Default	Internal default implementation for IUserPool.
static final class	IUserPool.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
UserPoolClient	addClient(String id)	Add a new app client to this user pool.
UserPoolClient	addClient(String id, UserPoolClientOptions options)	Add a new app client to this user pool.
UserPoolDomain	addDomain(String id, UserPoolDomainOptions options)	Associate a domain to this user pool.
UserPoolGroup	addGroup(String id, UserPoolGroupOptions options)	Add a new group to this user pool.
UserPoolResourceServer	addResourceServer(String id, UserPoolResourceServerOptions options)	Add a new resource server to this user pool.
List<IUserPoolIdentityProvider>	getIdentityProviders()	Get all identity providers registered with this user pool.
String	getUserPoolArn()	The ARN of this user pool resource.
String	getUserPoolId()	The physical ID of this user pool resource.
String	getUserPoolProviderName()	The provider name of this user pool resource.
Grant	grant(IGrantable grantee, String... actions)	Adds an IAM policy statement associated with this user pool to an IAM principal's policy.
void	registerIdentityProvider(IUserPoolIdentityProviderRef provider)	Register an identity provider with this user pool.

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.awscdk.interfaces.cognito.IUserPoolRef

getUserPoolRef

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentityProviders

@Stability(Stable)
@NotNull
List<IUserPoolIdentityProvider> getIdentityProviders()

Get all identity providers registered with this user pool.

getUserPoolArn

@Stability(Stable)
@NotNull
String getUserPoolArn()

The ARN of this user pool resource.

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The physical ID of this user pool resource.

getUserPoolProviderName

@Stability(Stable)
@NotNull
String getUserPoolProviderName()

The provider name of this user pool resource.

addClient

@Stability(Stable)
@NotNull
UserPoolClient addClient(@NotNull
 String id,
 @Nullable
 UserPoolClientOptions options)

Add a new app client to this user pool.

Parameters:

id - This parameter is required.

options -

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html

addClient

@Stability(Stable)
@NotNull
UserPoolClient addClient(@NotNull
 String id)

Add a new app client to this user pool.

Parameters:

id - This parameter is required.

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html

addDomain

@Stability(Stable)
@NotNull
UserPoolDomain addDomain(@NotNull
 String id,
 @NotNull
 UserPoolDomainOptions options)

Associate a domain to this user pool.

Parameters:

id - This parameter is required.

options - This parameter is required.

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html

addGroup

@Stability(Stable)
@NotNull
UserPoolGroup addGroup(@NotNull
 String id,
 @NotNull
 UserPoolGroupOptions options)

Add a new group to this user pool.

Parameters:

id - This parameter is required.

options - This parameter is required.

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html

addResourceServer

@Stability(Stable)
@NotNull
UserPoolResourceServer addResourceServer(@NotNull
 String id,
 @NotNull
 UserPoolResourceServerOptions options)

Add a new resource server to this user pool.

Parameters:

id - This parameter is required.

options - This parameter is required.

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-resource-servers.html

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

Adds an IAM policy statement associated with this user pool to an IAM principal's policy.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

registerIdentityProvider

@Stability(Stable)
void registerIdentityProvider(@NotNull
 IUserPoolIdentityProviderRef provider)

Register an identity provider with this user pool.

Parameters:

provider - This parameter is required.