Interface IUserPoolTriggers

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Triggers for a user pool.

public interface IUserPoolTriggers

Examples

var authChallengeFn = new Function(this, "authChallengeFn", new FunctionProps {
                 Runtime = Runtime.NODEJS_14_X,
                 Handler = "index.handler",
                 Code = Code.FromAsset(Join(__dirname, "path/to/asset"))
             });

             var userpool = new UserPool(this, "myuserpool", new UserPoolProps {
                 // ...
                 LambdaTriggers = new UserPoolTriggers {
                     CreateAuthChallenge = authChallengeFn
                 }
             });

             userpool.AddTrigger(UserPoolOperation.USER_MIGRATION, new Function(this, "userMigrationFn", new FunctionProps {
                 Runtime = Runtime.NODEJS_14_X,
                 Handler = "index.handler",
                 Code = Code.FromAsset(Join(__dirname, "path/to/asset"))
             }));

Remarks

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

ExampleMetadata: infused

Properties

CreateAuthChallenge

Creates an authentication challenge.

IFunction? CreateAuthChallenge { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

CustomEmailSender

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

IFunction? CustomEmailSender { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

CustomMessage

A custom Message AWS Lambda trigger.

IFunction? CustomMessage { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

CustomSmsSender

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

IFunction? CustomSmsSender { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

DefineAuthChallenge

Defines the authentication challenge.

IFunction? DefineAuthChallenge { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

PostAuthentication

A post-authentication AWS Lambda trigger.

IFunction? PostAuthentication { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

PostConfirmation

A post-confirmation AWS Lambda trigger.

IFunction? PostConfirmation { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

PreAuthentication

A pre-authentication AWS Lambda trigger.

IFunction? PreAuthentication { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

PreSignUp

A pre-registration AWS Lambda trigger.

IFunction? PreSignUp { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

PreTokenGeneration

A pre-token-generation AWS Lambda trigger.

IFunction? PreTokenGeneration { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

UserMigration

A user-migration AWS Lambda trigger.

IFunction? UserMigration { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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

VerifyAuthChallengeResponse

Verifies the authentication challenge response.

IFunction? VerifyAuthChallengeResponse { get; }

Property Value

IFunction

Remarks

Default: - no trigger configured

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