Package software.amazon.awscdk.services.cognito

Interface IUserPool.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IUserPool, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IUserPool.Jsii$Proxy

Enclosing interface:

IUserPool

@Internal
public static interface IUserPool.Jsii$Default
extends IUserPool, IResource.Jsii$Default

Internal default implementation for 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.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.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 Type	Method	Description
default 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 UserPoolGroup	addGroup(String id, UserPoolGroupOptions options)	Add a new group 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>	getIdentityProviders()	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	getUserPoolArn()	The ARN of this user pool resource.
default String	getUserPoolId()	The physical ID of this user pool resource.
default String	getUserPoolProviderName()	The provider name of this user pool resource.
default Grant	grant(IGrantable grantee, String... actions)	Adds an IAM policy statement associated with this user pool to an IAM principal's policy.
default void	registerIdentityProvider(IUserPoolIdentityProvider provider)	Register an identity provider with this user pool.

Methods inherited from interface software.amazon.awscdk.services.cognito.IUserPool

addClient

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 interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getIdentityProviders

@Stability(Stable)
@NotNull
default List<IUserPoolIdentityProvider> getIdentityProviders()

Get all identity providers registered with this user pool.

Specified by:

getIdentityProviders in interface IUserPool

getUserPoolArn

@Stability(Stable)
@NotNull
default String getUserPoolArn()

The ARN of this user pool resource.

Specified by:

getUserPoolArn in interface IUserPool

getUserPoolId

@Stability(Stable)
@NotNull
default String getUserPoolId()

The physical ID of this user pool resource.

Specified by:

getUserPoolId in interface IUserPool

getUserPoolProviderName

@Stability(Stable)
@NotNull
default String getUserPoolProviderName()

The provider name of this user pool resource.

Specified by:

getUserPoolProviderName in interface IUserPool

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

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 interface IResource

Specified by:

applyRemovalPolicy in interface IResource.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.

Specified by:

addClient in interface IUserPool

Parameters:

id - This parameter is required.

options -

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html

addDomain

@Stability(Stable)
@NotNull
default UserPoolDomain addDomain(@NotNull
 String id,
 @NotNull
 UserPoolDomainOptions options)

Associate a domain to this user pool.

Specified by:

addDomain in interface IUserPool

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

addGroup

@Stability(Stable)
@NotNull
default UserPoolGroup addGroup(@NotNull
 String id,
 @NotNull
 UserPoolGroupOptions options)

Add a new group to this user pool.

Specified by:

addGroup in interface IUserPool

Parameters:

id - This parameter is required.

options - This parameter is required.

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html

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 interface IUserPool

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(Stable)
@NotNull
default Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

Adds an IAM policy statement associated with this user pool to an IAM principal's policy.

Specified by:

grant in interface IUserPool

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

registerIdentityProvider

@Stability(Stable)
default void registerIdentityProvider(@NotNull
 IUserPoolIdentityProvider provider)

Register an identity provider with this user pool.

Specified by:

registerIdentityProvider in interface IUserPool

Parameters:

provider - This parameter is required.