Skip to content

update auth example for "moving to production" email with senders #8020

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 10, 2024
Merged

update auth example for "moving to production" email with senders #8020

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
203d276
update auth example for "moving to production" email with `senders`
josefaidt Oct 7, 2024
ddfb4a4
update jsdoc links
josefaidt Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 41 additions & 24 deletions src/pages/[platform]/build-a-backend/auth/moving-to-production/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,33 +44,50 @@ To get started with Amazon SES in production, you must first [request production

After you have configured your account for production access and have verified your _sender_ email, you can configure your Cognito user pool to send emails using the verified sender:

```ts title="amplify/backend.ts"
import { Stack } from "aws-cdk-lib/core"
import { EmailIdentity } from "aws-cdk-lib/aws-ses"
import { defineBackend } from "@aws-amplify/backend"
import { auth } from "./auth/resource"

const backend = defineBackend({
auth,
```ts title="amplify/auth/resource.ts"
import { defineAuth } from "@aws-amplify/backend"

/**
* Define and configure your auth resource
* @see https://docs.amplify.aws/react/build-a-backend/auth
*/
export const auth = defineAuth({
loginWith: {
email: true,
},
senders: {
email: {
// configure using the email registered and verified in Amazon SES
fromEmail: "[email protected]",
},
},
})

const { cfnUserPool } = backend.auth.resources.cfnResources
const authStack = Stack.of(cfnUserPool)

const email = EmailIdentity.fromEmailIdentityName(
authStack,
"EmailIdentity",
// your email configured for use in SES
process.env.EMAIL
)

cfnUserPool.emailConfiguration = {
emailSendingAccount: "DEVELOPER",
sourceArn: email.emailIdentityArn,
}
```

Now when emails are sent on new user sign-ups, password resets, etc., the sending account will be your verified email.
Now when emails are sent on new user sign-ups, password resets, etc., the sending account will be your verified email! To customize further, you can change the display name of the sender, or optionally apply a custom address for your users to reply.

```ts title="amplify/auth/resource.ts"
import { defineAuth } from "@aws-amplify/backend"

/**
* Define and configure your auth resource
* @see https://docs.amplify.aws/react/build-a-backend/auth
*/
export const auth = defineAuth({
loginWith: {
email: true,
},
senders: {
email: {
fromEmail: "[email protected]",
// highlight-start
fromName: "MyApp",
replyTo: "[email protected]"
// highlight-end
},
},
})
```

## SMS

Expand Down