software.amazon.awscdk.services.cognito

Interface IUserPool

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IUserPool.Jsii$Default

All Known Implementing Classes:

IUserPool.Jsii$Proxy, UserPool

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:13.291Z")
public interface IUserPool
extends IResource

Represents a Cognito UserPool.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
UserPoolClient	addClient(java.lang.String id) Add a new app client to this user pool.
UserPoolClient	addClient(java.lang.String id, UserPoolClientOptions options) Add a new app client to this user pool.
UserPoolDomain	addDomain(java.lang.String id, UserPoolDomainOptions options) Associate a domain to this user pool.
UserPoolResourceServer	addResourceServer(java.lang.String id, UserPoolResourceServerOptions options) Add a new resource server to this user pool.
java.util.List<IUserPoolIdentityProvider>	getIdentityProviders() Get all identity providers registered with this user pool.
java.lang.String	getUserPoolArn() The ARN of this user pool resource.
java.lang.String	getUserPoolId() The physical ID of this user pool resource.
void	registerIdentityProvider(IUserPoolIdentityProvider provider) Register an identity provider with this user pool.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Method Detail

getIdentityProviders

java.util.List<IUserPoolIdentityProvider> getIdentityProviders()

Get all identity providers registered with this user pool.

getUserPoolArn

java.lang.String getUserPoolArn()

The ARN of this user pool resource.

getUserPoolId

java.lang.String getUserPoolId()

The physical ID of this user pool resource.

addClient

UserPoolClient addClient(java.lang.String id,
                         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

UserPoolClient addClient(java.lang.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

UserPoolDomain addDomain(java.lang.String id,
                         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

addResourceServer

UserPoolResourceServer addResourceServer(java.lang.String id,
                                         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

registerIdentityProvider

void registerIdentityProvider(IUserPoolIdentityProvider provider)

Register an identity provider with this user pool.

Parameters:

provider - This parameter is required.