software.amazon.awscdk.services.cognito

Interface IUserPool

All Superinterfaces:

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

All Known Subinterfaces:

IUserPool.Jsii$Default

All Known Implementing Classes:

IUserPool.Jsii$Proxy, UserPool

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.670Z")
 @Stability(value=Stable)
public interface IUserPool
extends software.amazon.jsii.JsiiSerializable, 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(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.
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.
Grant	grant(IGrantable grantee, String... actions) Adds an IAM policy statement associated with this user pool to an IAM principal's policy.
void	registerIdentityProvider(IUserPoolIdentityProvider provider) Register an identity provider with this user pool.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIdentityProviders

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

Get all identity providers registered with this user pool.

getUserPoolArn

@Stability(value=Stable)
 @NotNull
String getUserPoolArn()

The ARN of this user pool resource.

getUserPoolId

@Stability(value=Stable)
 @NotNull
String getUserPoolId()

The physical ID of this user pool resource.

addClient

@Stability(value=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(value=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(value=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

addResourceServer

@Stability(value=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(value=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(value=Stable)
void registerIdentityProvider(@NotNull
                                                       IUserPoolIdentityProvider provider)

Register an identity provider with this user pool.

Parameters:

provider - This parameter is required.