AWS CDK Reference

Appearance

v2.275.0

UserPoolEmail Class ​

Configure how Cognito sends emails.

Source
aws-cognito/lib/user-pool-email.ts

Example ​

ts
new cognito.UserPool(this, 'myuserpool', {
  email: cognito.UserPoolEmail.withSES({
    fromEmail: 'noreply@myawesomeapp.com',
    fromName: 'Awesome App',
    replyTo: 'support@myawesomeapp.com',
  }),
});

Initializer ​

ts
new UserPoolEmail()
python
UserPoolEmail()
java
new UserPoolEmail()
csharp
new UserPoolEmail()
go
NewUserPoolEmail()

Methods ​

withCognito(replyTo?: string): UserPoolEmail // chainable@staticmethod def with_cognito(reply_to: typing.Optional[str] = None) -> UserPoolEmailpublic static UserPoolEmail withCognito(String replyTo)public static UserPoolEmail WithCognito(string? replyTo = null)func WithCognito(ReplyTo *string) UserPoolEmailstatic#
Send email using Cognito.
withSES(options: UserPoolSESOptions): UserPoolEmail // chainable@staticmethod def with_ses(options: UserPoolSESOptions) -> UserPoolEmailpublic static UserPoolEmail withSES(UserPoolSESOptions options)public static UserPoolEmail WithSES(UserPoolSESOptions options)func WithSES(Options UserPoolSESOptions) UserPoolEmailstatic#
Send email using SES.