Interface IUserPool.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
,IResource
,IResource.Jsii$Default
,IUserPool
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IUserPool.Jsii$Proxy
- Enclosing interface:
IUserPool
IUserPool
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPool
IUserPool.Jsii$Default, IUserPool.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault UserPoolClient
addClient
(String id, UserPoolClientOptions options) Add a new app client to this user pool.default UserPoolDomain
addDomain
(String id, UserPoolDomainOptions options) Associate a domain to this user pool.default UserPoolResourceServer
addResourceServer
(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 List<IUserPoolIdentityProvider>
Get all identity providers registered with this user pool.default software.constructs.Node
getNode()
The tree node.default Stack
getStack()
The stack in which this resource is defined.default String
The ARN of this user pool resource.default String
The physical ID of this user pool resource.default String
The provider name of this user pool resource.default Grant
grant
(IGrantable grantee, @NotNull String... actions) Adds an IAM policy statement associated with this user pool to an IAM principal's policy.default void
Register an identity provider with this user pool.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.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.
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getIdentityProviders
Get all identity providers registered with this user pool.- Specified by:
getIdentityProviders
in interfaceIUserPool
-
getUserPoolArn
The ARN of this user pool resource.- Specified by:
getUserPoolArn
in interfaceIUserPool
-
getUserPoolId
The physical ID of this user pool resource.- Specified by:
getUserPoolId
in interfaceIUserPool
-
getUserPoolProviderName
The provider name of this user pool resource.- Specified by:
getUserPoolProviderName
in interfaceIUserPool
-
applyRemovalPolicy
Apply the given removal policy to this resource.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
).- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addClient
@Stability(Stable) @NotNull default UserPoolClient addClient(@NotNull String id, @Nullable UserPoolClientOptions options) Add a new app client to this user pool. -
addDomain
@Stability(Stable) @NotNull default UserPoolDomain addDomain(@NotNull String id, @NotNull UserPoolDomainOptions options) Associate a domain to this user pool. -
addResourceServer
@Stability(Stable) @NotNull default UserPoolResourceServer addResourceServer(@NotNull String id, @NotNull UserPoolResourceServerOptions options) Add a new resource server to this user pool.- Specified by:
addResourceServer
in interfaceIUserPool
- Parameters:
id
- This parameter is required.options
- This parameter is required.- See Also:
-
grant
@Stability(Stable) @NotNull default 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. -
registerIdentityProvider
@Stability(Stable) default void registerIdentityProvider(@NotNull IUserPoolIdentityProvider provider) Register an identity provider with this user pool.- Specified by:
registerIdentityProvider
in interfaceIUserPool
- Parameters:
provider
- This parameter is required.
-