Package software.amazon.awscdk.services.cognito

Interface UserPoolTriggers

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserPoolTriggers.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-01-25T00:20:53.095Z")
@Stability(Stable)
public interface UserPoolTriggers
extends software.amazon.jsii.JsiiSerializable

Triggers for a user pool.

Example:

 Function authChallengeFn = Function.Builder.create(this, "authChallengeFn")
         .runtime(Runtime.NODEJS_LATEST)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "path/to/asset")))
         .build();
 UserPool userpool = UserPool.Builder.create(this, "myuserpool")
         // ...
         .lambdaTriggers(UserPoolTriggers.builder()
                 .createAuthChallenge(authChallengeFn)
                 .build())
         .build();
 userpool.addTrigger(UserPoolOperation.USER_MIGRATION, Function.Builder.create(this, "userMigrationFn")
         .runtime(Runtime.NODEJS_LATEST)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "path/to/asset")))
         .build());
 

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserPoolTriggers.Builder	A builder for UserPoolTriggers
static final class	UserPoolTriggers.Jsii$Proxy	An implementation for UserPoolTriggers

Method Summary

Modifier and Type	Method	Description
static UserPoolTriggers.Builder	builder()
default IFunction	getCreateAuthChallenge()	Creates an authentication challenge.
default IFunction	getCustomEmailSender()	Amazon Cognito invokes this trigger to send email notifications to users.
default IFunction	getCustomMessage()	A custom Message AWS Lambda trigger.
default IFunction	getCustomSmsSender()	Amazon Cognito invokes this trigger to send SMS notifications to users.
default IFunction	getDefineAuthChallenge()	Defines the authentication challenge.
default IFunction	getPostAuthentication()	A post-authentication AWS Lambda trigger.
default IFunction	getPostConfirmation()	A post-confirmation AWS Lambda trigger.
default IFunction	getPreAuthentication()	A pre-authentication AWS Lambda trigger.
default IFunction	getPreSignUp()	A pre-registration AWS Lambda trigger.
default IFunction	getPreTokenGeneration()	A pre-token-generation AWS Lambda trigger.
default IFunction	getUserMigration()	A user-migration AWS Lambda trigger.
default IFunction	getVerifyAuthChallengeResponse()	Verifies the authentication challenge response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCreateAuthChallenge

@Stability(Stable)
@Nullable
default IFunction getCreateAuthChallenge()

Creates an authentication challenge.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-create-auth-challenge.html

getCustomEmailSender

@Stability(Stable)
@Nullable
default IFunction getCustomEmailSender()

Amazon Cognito invokes this trigger to send email notifications to users.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-email-sender.html

getCustomMessage

@Stability(Stable)
@Nullable
default IFunction getCustomMessage()

A custom Message AWS Lambda trigger.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-message.html

getCustomSmsSender

@Stability(Stable)
@Nullable
default IFunction getCustomSmsSender()

Amazon Cognito invokes this trigger to send SMS notifications to users.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-sms-sender.html

getDefineAuthChallenge

@Stability(Stable)
@Nullable
default IFunction getDefineAuthChallenge()

Defines the authentication challenge.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-define-auth-challenge.html

getPostAuthentication

@Stability(Stable)
@Nullable
default IFunction getPostAuthentication()

A post-authentication AWS Lambda trigger.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html

getPostConfirmation

@Stability(Stable)
@Nullable
default IFunction getPostConfirmation()

A post-confirmation AWS Lambda trigger.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html

getPreAuthentication

@Stability(Stable)
@Nullable
default IFunction getPreAuthentication()

A pre-authentication AWS Lambda trigger.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html

getPreSignUp

@Stability(Stable)
@Nullable
default IFunction getPreSignUp()

A pre-registration AWS Lambda trigger.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html

getPreTokenGeneration

@Stability(Stable)
@Nullable
default IFunction getPreTokenGeneration()

A pre-token-generation AWS Lambda trigger.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html

getUserMigration

@Stability(Stable)
@Nullable
default IFunction getUserMigration()

A user-migration AWS Lambda trigger.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html

getVerifyAuthChallengeResponse

@Stability(Stable)
@Nullable
default IFunction getVerifyAuthChallengeResponse()

Verifies the authentication challenge response.

Default: - no trigger configured

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-verify-auth-challenge-response.html

builder

@Stability(Stable)
static UserPoolTriggers.Builder builder()

Returns:

a UserPoolTriggers.Builder of UserPoolTriggers