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.102.0 (build e354887)",
date="2024-09-06T01:36:25.576Z")
@Stability(Stable)
public interface IUserPool
extends software.amazon.jsii.JsiiSerializable, IResource
Represents a Cognito UserPool.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIUserPool
.static final class
A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptionAdd a new app client to this user pool.addClient
(String id, UserPoolClientOptions options) Add a new app client to this user pool.addDomain
(String id, UserPoolDomainOptions options) Associate a domain to this user pool.addResourceServer
(String id, UserPoolResourceServerOptions options) Add a new resource server to this user pool.Get all identity providers registered with this user pool.The ARN of this user pool resource.The physical ID of this user pool resource.grant
(IGrantable grantee, @NotNull String... actions) Adds an IAM policy statement associated with this user pool to an IAM principal's policy.void
Register an identity provider with this user pool.Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIdentityProviders
Get all identity providers registered with this user pool. -
getUserPoolArn
The ARN of this user pool resource. -
getUserPoolId
The physical ID 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:
-
addClient
Add a new app client to this user pool.- Parameters:
id
- This parameter is required.- See Also:
-
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:
-
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:
-
grant
@Stability(Stable) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull @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
Register an identity provider with this user pool.- Parameters:
provider
- This parameter is required.
-