Interface IUserPoolTriggers
Triggers for a user pool.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface IUserPoolTriggers
Syntax (vb)
Public Interface IUserPoolTriggers
Remarks
ExampleMetadata: infused
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"))
}));
Synopsis
Properties
CreateAuthChallenge | Creates an authentication challenge. |
CustomEmailSender | Amazon Cognito invokes this trigger to send email notifications to users. |
CustomMessage | A custom Message AWS Lambda trigger. |
CustomSmsSender | Amazon Cognito invokes this trigger to send SMS notifications to users. |
DefineAuthChallenge | Defines the authentication challenge. |
PostAuthentication | A post-authentication AWS Lambda trigger. |
PostConfirmation | A post-confirmation AWS Lambda trigger. |
PreAuthentication | A pre-authentication AWS Lambda trigger. |
PreSignUp | A pre-registration AWS Lambda trigger. |
PreTokenGeneration | A pre-token-generation AWS Lambda trigger. |
UserMigration | A user-migration AWS Lambda trigger. |
VerifyAuthChallengeResponse | Verifies the authentication challenge response. |
Properties
CreateAuthChallenge
Creates an authentication challenge.
virtual IFunction CreateAuthChallenge { get; }
Property Value
Remarks
Default: - no trigger configured
CustomEmailSender
Amazon Cognito invokes this trigger to send email notifications to users.
virtual IFunction CustomEmailSender { get; }
Property Value
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.
virtual IFunction CustomMessage { get; }
Property Value
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.
virtual IFunction CustomSmsSender { get; }
Property Value
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.
virtual IFunction DefineAuthChallenge { get; }
Property Value
Remarks
Default: - no trigger configured
PostAuthentication
A post-authentication AWS Lambda trigger.
virtual IFunction PostAuthentication { get; }
Property Value
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.
virtual IFunction PostConfirmation { get; }
Property Value
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.
virtual IFunction PreAuthentication { get; }
Property Value
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.
virtual IFunction PreSignUp { get; }
Property Value
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.
virtual IFunction PreTokenGeneration { get; }
Property Value
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.
virtual IFunction UserMigration { get; }
Property Value
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.
virtual IFunction VerifyAuthChallengeResponse { get; }
Property Value
Remarks
Default: - no trigger configured