UserPoolOperation Class
User pool operations to which lambda triggers can be attached.
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
CREATE_AUTH_CHALLENGEUserPoolOperationcreate_auth_challengeUserPoolOperationCREATE_AUTH_CHALLENGEUserPoolOperationCREATE_AUTH_CHALLENGEUserPoolOperationCREATE_AUTH_CHALLENGEUserPoolOperationrequiredstatic#Creates a challenge in a custom auth flow.
CUSTOM_EMAIL_SENDERUserPoolOperationcustom_email_senderUserPoolOperationCUSTOM_EMAIL_SENDERUserPoolOperationCUSTOM_EMAIL_SENDERUserPoolOperationCUSTOM_EMAIL_SENDERUserPoolOperationrequiredstatic#Amazon Cognito invokes this trigger to send email notifications to users.
CUSTOM_MESSAGEUserPoolOperationcustom_messageUserPoolOperationCUSTOM_MESSAGEUserPoolOperationCUSTOM_MESSAGEUserPoolOperationCUSTOM_MESSAGEUserPoolOperationrequiredstatic#Advanced customization and localization of messages.
CUSTOM_SMS_SENDERUserPoolOperationcustom_sms_senderUserPoolOperationCUSTOM_SMS_SENDERUserPoolOperationCUSTOM_SMS_SENDERUserPoolOperationCUSTOM_SMS_SENDERUserPoolOperationrequiredstatic#Amazon Cognito invokes this trigger to send email notifications to users.
DEFINE_AUTH_CHALLENGEUserPoolOperationdefine_auth_challengeUserPoolOperationDEFINE_AUTH_CHALLENGEUserPoolOperationDEFINE_AUTH_CHALLENGEUserPoolOperationDEFINE_AUTH_CHALLENGEUserPoolOperationrequiredstatic#Determines the next challenge in a custom auth flow.
operationNamestringoperation_namestroperationNameStringOperationNamestringOperationName*stringrequired#The key to use in `CfnUserPool.LambdaConfigProperty`.
POST_AUTHENTICATIONUserPoolOperationpost_authenticationUserPoolOperationPOST_AUTHENTICATIONUserPoolOperationPOST_AUTHENTICATIONUserPoolOperationPOST_AUTHENTICATIONUserPoolOperationrequiredstatic#Event logging for custom analytics.
POST_CONFIRMATIONUserPoolOperationpost_confirmationUserPoolOperationPOST_CONFIRMATIONUserPoolOperationPOST_CONFIRMATIONUserPoolOperationPOST_CONFIRMATIONUserPoolOperationrequiredstatic#Custom welcome messages or event logging for custom analytics.
PRE_AUTHENTICATIONUserPoolOperationpre_authenticationUserPoolOperationPRE_AUTHENTICATIONUserPoolOperationPRE_AUTHENTICATIONUserPoolOperationPRE_AUTHENTICATIONUserPoolOperationrequiredstatic#Custom validation to accept or deny the sign-in request.
PRE_SIGN_UPUserPoolOperationpre_sign_upUserPoolOperationPRE_SIGN_UPUserPoolOperationPRE_SIGN_UPUserPoolOperationPRE_SIGN_UPUserPoolOperationrequiredstatic#Custom validation to accept or deny the sign-up request.
PRE_TOKEN_GENERATIONUserPoolOperationpre_token_generationUserPoolOperationPRE_TOKEN_GENERATIONUserPoolOperationPRE_TOKEN_GENERATIONUserPoolOperationPRE_TOKEN_GENERATIONUserPoolOperationrequiredstatic#Add or remove attributes in Id tokens.
notes
Set this parameter for legacy purposes. If you also set an ARN in PreTokenGenerationConfig, its value must be identical to PreTokenGeneration. For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig.
PRE_TOKEN_GENERATION_CONFIGUserPoolOperationpre_token_generation_configUserPoolOperationPRE_TOKEN_GENERATION_CONFIGUserPoolOperationPRE_TOKEN_GENERATION_CONFIGUserPoolOperationPRE_TOKEN_GENERATION_CONFIGUserPoolOperationrequiredstatic#Add or remove attributes in Id tokens and Access tokens.
USER_MIGRATIONUserPoolOperationuser_migrationUserPoolOperationUSER_MIGRATIONUserPoolOperationUSER_MIGRATIONUserPoolOperationUSER_MIGRATIONUserPoolOperationrequiredstatic#Migrate a user from an existing user directory to user pools.
VERIFY_AUTH_CHALLENGE_RESPONSEUserPoolOperationverify_auth_challenge_responseUserPoolOperationVERIFY_AUTH_CHALLENGE_RESPONSEUserPoolOperationVERIFY_AUTH_CHALLENGE_RESPONSEUserPoolOperationVERIFY_AUTH_CHALLENGE_RESPONSEUserPoolOperationrequiredstatic#Determines if a response is correct in a custom auth flow.
Methods
of(name: string): UserPoolOperation // chainable@staticmethod def of(name: str) -> UserPoolOperationpublic static UserPoolOperation of(String name)public static UserPoolOperation Of(string name)func Of(Name *string) UserPoolOperationstatic#A custom user pool operation.