UserPoolTriggers Struct
Triggers for a user pool.
Example
ts
const authChallengeFn = new lambda.Function(this, 'authChallengeFn', {
runtime: lambda.Runtime.NODEJS_LATEST,
handler: 'index.handler',
code: lambda.Code.fromAsset(path.join(__dirname, 'path/to/asset')),
});
const userpool = new cognito.UserPool(this, 'myuserpool', {
// ...
lambdaTriggers: {
createAuthChallenge: authChallengeFn,
// ...
},
});
userpool.addTrigger(cognito.UserPoolOperation.USER_MIGRATION, new lambda.Function(this, 'userMigrationFn', {
runtime: lambda.Runtime.NODEJS_LATEST,
handler: 'index.handler',
code: lambda.Code.fromAsset(path.join(__dirname, 'path/to/asset')),
}));
Properties
createAuthChallengeoptionalIFunctioncreate_auth_challengeoptionalIFunctioncreateAuthChallengeoptionalIFunctionCreateAuthChallengeoptionalIFunctionCreateAuthChallengeoptionalIFunction#Creates an authentication challenge.
Default: no trigger configured
customEmailSenderoptionalIFunctioncustom_email_senderoptionalIFunctioncustomEmailSenderoptionalIFunctionCustomEmailSenderoptionalIFunctionCustomEmailSenderoptionalIFunction#Amazon Cognito invokes this trigger to send email notifications to users.
Default: no trigger configured
customMessageoptionalIFunctioncustom_messageoptionalIFunctioncustomMessageoptionalIFunctionCustomMessageoptionalIFunctionCustomMessageoptionalIFunction#A custom Message AWS Lambda trigger.
Default: no trigger configured
customSmsSenderoptionalIFunctioncustom_sms_senderoptionalIFunctioncustomSmsSenderoptionalIFunctionCustomSmsSenderoptionalIFunctionCustomSmsSenderoptionalIFunction#Amazon Cognito invokes this trigger to send SMS notifications to users.
Default: no trigger configured
defineAuthChallengeoptionalIFunctiondefine_auth_challengeoptionalIFunctiondefineAuthChallengeoptionalIFunctionDefineAuthChallengeoptionalIFunctionDefineAuthChallengeoptionalIFunction#Defines the authentication challenge.
Default: no trigger configured
postAuthenticationoptionalIFunctionpost_authenticationoptionalIFunctionpostAuthenticationoptionalIFunctionPostAuthenticationoptionalIFunctionPostAuthenticationoptionalIFunction#A post-authentication AWS Lambda trigger.
Default: no trigger configured
postConfirmationoptionalIFunctionpost_confirmationoptionalIFunctionpostConfirmationoptionalIFunctionPostConfirmationoptionalIFunctionPostConfirmationoptionalIFunction#A post-confirmation AWS Lambda trigger.
Default: no trigger configured
preAuthenticationoptionalIFunctionpre_authenticationoptionalIFunctionpreAuthenticationoptionalIFunctionPreAuthenticationoptionalIFunctionPreAuthenticationoptionalIFunction#A pre-authentication AWS Lambda trigger.
Default: no trigger configured
preSignUpoptionalIFunctionpre_sign_upoptionalIFunctionpreSignUpoptionalIFunctionPreSignUpoptionalIFunctionPreSignUpoptionalIFunction#A pre-registration AWS Lambda trigger.
Default: no trigger configured
preTokenGenerationoptionalIFunctionpre_token_generationoptionalIFunctionpreTokenGenerationoptionalIFunctionPreTokenGenerationoptionalIFunctionPreTokenGenerationoptionalIFunction#A pre-token-generation AWS Lambda trigger.
Default: no trigger configured
userMigrationoptionalIFunctionuser_migrationoptionalIFunctionuserMigrationoptionalIFunctionUserMigrationoptionalIFunctionUserMigrationoptionalIFunction#A user-migration AWS Lambda trigger.
Default: no trigger configured
verifyAuthChallengeResponseoptionalIFunctionverify_auth_challenge_responseoptionalIFunctionverifyAuthChallengeResponseoptionalIFunctionVerifyAuthChallengeResponseoptionalIFunctionVerifyAuthChallengeResponseoptionalIFunction#Verifies the authentication challenge response.
Default: no trigger configured