feat: Add support for custom Lambda function email senders in Auth construct #2087
Conversation
🦋 Changeset detectedLatest commit: eb24c3e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| @@ -421,7 +425,10 @@ export type AuthProps = { | |||
| * SES configurations enable the use of customized email sender addresses and names | |||
| * @see https://docs.amplify.aws/react/build-a-backend/auth/moving-to-production/#email | |||
There was a problem hiding this comment.
You will probably want to update this docs section with the parts that I left out when initially implementing senders --
this was the full docs message:
Configure Cognito to send emails from SES or a custom message trigger
SES configurations enable the use of customized email sender addresses and names
Custom message triggers enable the use of third-party email providers when sending email notifications to users
@see https://docs.amplify.aws/react/build-a-backend/auth/moving-to-production/#email
@see https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-email-sender.html
| @@ -47,7 +49,7 @@ export type AuthProps = { | |||
| externalProviders?: ExternalProviderOptions; | |||
| }; | |||
| senders?: { | |||
| email: Pick<UserPoolSESOptions, 'fromEmail' | 'fromName' | 'replyTo'>; | |||
| email: Pick<UserPoolSESOptions, 'fromEmail' | 'fromName' | 'replyTo'> | IFunction | AmplifyFunction; | |||
There was a problem hiding this comment.
AmplifyFunction should be an input to defineAuth not to the construct.
There are couple of examples is backend-data that may be looked at.
For example, take a look how these two are handled
It should be that
const someFunction = defineFunction();
const auth = defineAuth({ senders: { email: someFunction });
under the hood. the auth construct factory should resolve the reference to IFunction (see how data does this under the hood) and pass it to auth construct as IFunction.
| props.senders?.email && | ||
| props.senders.email instanceof lambda.Function | ||
| ) { | ||
| if (!this.customSenderKmsKey) { |
There was a problem hiding this comment.
does this have to be an instance variable?
| ) { | ||
| if (!this.customSenderKmsKey) { | ||
| this.customSenderKmsKey = new Key(this, 'CustomSenderKey', { | ||
| description: 'KMS key for Cognito custom sender', |
There was a problem hiding this comment.
please include user pool name (or some other identifier) in the description.
Problem
This PR addresses the need for more flexible email sender configuration in the Auth construct, specifically allowing the use of custom Lambda functions for email sending capabilities.
Changes
Validation
A new test case was added in construct.test.ts to verify the behavior when a function is provided as an email sender. This test ensures that the custom email sender is properly set up when a Lambda function is provided.
Checklist