public static interface IUserPool.Jsii$Default extends IUserPool, IResource.Jsii$Default
IUserPool
.IUserPool.Jsii$Default, IUserPool.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default UserPoolClient |
addClient(java.lang.String id,
UserPoolClientOptions options)
Add a new app client to this user pool.
|
default UserPoolDomain |
addDomain(java.lang.String id,
UserPoolDomainOptions options)
Associate a domain to this user pool.
|
default UserPoolResourceServer |
addResourceServer(java.lang.String id,
UserPoolResourceServerOptions options)
Add a new resource server to this user pool.
|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default java.util.List<IUserPoolIdentityProvider> |
getIdentityProviders()
Get all identity providers registered with this user pool.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default java.lang.String |
getUserPoolArn()
The ARN of this user pool resource.
|
default java.lang.String |
getUserPoolId()
The physical ID of this user pool resource.
|
default void |
registerIdentityProvider(IUserPoolIdentityProvider provider)
Register an identity provider with this user pool.
|
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
default ResourceEnvironment getEnv()
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
default java.util.List<IUserPoolIdentityProvider> getIdentityProviders()
getIdentityProviders
in interface IUserPool
default java.lang.String getUserPoolArn()
getUserPoolArn
in interface IUserPool
default java.lang.String getUserPoolId()
getUserPoolId
in interface IUserPool
default void applyRemovalPolicy(RemovalPolicy policy)
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
policy
- This parameter is required.default UserPoolClient addClient(java.lang.String id, UserPoolClientOptions options)
addClient
in interface IUserPool
id
- This parameter is required.options
- default UserPoolDomain addDomain(java.lang.String id, UserPoolDomainOptions options)
addDomain
in interface IUserPool
id
- This parameter is required.options
- This parameter is required.default UserPoolResourceServer addResourceServer(java.lang.String id, UserPoolResourceServerOptions options)
addResourceServer
in interface IUserPool
id
- This parameter is required.options
- This parameter is required.default void registerIdentityProvider(IUserPoolIdentityProvider provider)
registerIdentityProvider
in interface IUserPool
provider
- This parameter is required.