Skip to content
v2.273.0

CustomEmailSenderProperty Struct ​

The configuration of a custom email sender Lambda trigger.

This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const customEmailSenderProperty: cognito.CfnUserPool.CustomEmailSenderProperty = {
  lambdaArn: 'lambdaArn',
  lambdaVersion: 'lambdaVersion',
};

Properties ​

lambdaArnstringlambda_arnstrlambdaArnStringLambdaArnstringLambdaArn*string#
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
lambdaVersionstringlambda_versionstrlambdaVersionStringLambdaVersionstringLambdaVersion*string#
The user pool trigger version of the request that Amazon Cognito sends to your Lambda function.

Higher-numbered versions add fields that support new features.

You must use a LambdaVersion of V1_0 with a custom sender function.