Package software.amazon.awscdk.services.cognito

Class IUserPool.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.IUserPool.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IUserPool

@Internal
public static final class IUserPool.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IUserPool.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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.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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
final UserPoolClient	addClient(String id)	Add a new app client to this user pool.
final UserPoolClient	addClient(String id, UserPoolClientOptions options)	Add a new app client to this user pool.
final UserPoolDomain	addDomain(String id, UserPoolDomainOptions options)	Associate a domain to this user pool.
final UserPoolGroup	addGroup(String id, UserPoolGroupOptions options)	Add a new group to this user pool.
final UserPoolResourceServer	addResourceServer(String id, UserPoolResourceServerOptions options)	Add a new resource server to this user pool.
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final List<IUserPoolIdentityProvider>	getIdentityProviders()	Get all identity providers registered with this user pool.
final software.constructs.Node	getNode()	The tree node.
final Stack	getStack()	The stack in which this resource is defined.
final String	getUserPoolArn()	The ARN of this user pool resource.
final String	getUserPoolId()	The physical ID of this user pool resource.
final String	getUserPoolProviderName()	The provider name of this user pool resource.
final Grant	grant(IGrantable grantee, String... actions)	Adds an IAM policy statement associated with this user pool to an IAM principal's policy.
final void	registerIdentityProvider(IUserPoolIdentityProvider provider)	Register an identity provider with this user pool.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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

Specified by:

getNode in interface IUserPool.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final 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

Specified by:

getEnv in interface IUserPool.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IUserPool.Jsii$Default

getIdentityProviders

@Stability(Stable)
@NotNull
public final List<IUserPoolIdentityProvider> getIdentityProviders()

Get all identity providers registered with this user pool.

Specified by:

getIdentityProviders in interface IUserPool

Specified by:

getIdentityProviders in interface IUserPool.Jsii$Default

getUserPoolArn

@Stability(Stable)
@NotNull
public final String getUserPoolArn()

The ARN of this user pool resource.

Specified by:

getUserPoolArn in interface IUserPool

Specified by:

getUserPoolArn in interface IUserPool.Jsii$Default

getUserPoolId

@Stability(Stable)
@NotNull
public final String getUserPoolId()

The physical ID of this user pool resource.

Specified by:

getUserPoolId in interface IUserPool

Specified by:

getUserPoolId in interface IUserPool.Jsii$Default

getUserPoolProviderName

@Stability(Stable)
@NotNull
public final String getUserPoolProviderName()

The provider name of this user pool resource.

Specified by:

getUserPoolProviderName in interface IUserPool

Specified by:

getUserPoolProviderName in interface IUserPool.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final 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

Specified by:

applyRemovalPolicy in interface IUserPool.Jsii$Default

Parameters:

policy - This parameter is required.

addClient

@Stability(Stable)
@NotNull
public final UserPoolClient addClient(@NotNull
 String id,
 @Nullable
 UserPoolClientOptions options)

Add a new app client to this user pool.

Specified by:

addClient in interface IUserPool

Specified by:

addClient in interface IUserPool.Jsii$Default

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(Stable)
@NotNull
public final UserPoolClient addClient(@NotNull
 String id)

Add a new app client to this user pool.

Specified by:

addClient in interface IUserPool

Parameters:

id - This parameter is required.

See Also:

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

addDomain

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

Associate a domain to this user pool.

Specified by:

addDomain in interface IUserPool

Specified by:

addDomain in interface IUserPool.Jsii$Default

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
public final UserPoolGroup addGroup(@NotNull
 String id,
 @NotNull
 UserPoolGroupOptions options)

Add a new group to this user pool.

Specified by:

addGroup in interface IUserPool

Specified by:

addGroup in interface IUserPool.Jsii$Default

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
public final UserPoolResourceServer addResourceServer(@NotNull
 String id,
 @NotNull
 UserPoolResourceServerOptions options)

Add a new resource server to this user pool.

Specified by:

addResourceServer in interface IUserPool

Specified by:

addResourceServer in interface IUserPool.Jsii$Default

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
public final 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

Specified by:

grant in interface IUserPool.Jsii$Default

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

registerIdentityProvider

@Stability(Stable)
public final void registerIdentityProvider(@NotNull
 IUserPoolIdentityProvider provider)

Register an identity provider with this user pool.

Specified by:

registerIdentityProvider in interface IUserPool

Specified by:

registerIdentityProvider in interface IUserPool.Jsii$Default

Parameters:

provider - This parameter is required.