aws-cdk-lib.aws_cognito.UserPoolEmail

class UserPoolEmail

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolEmail
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolEmail
Javasoftware.amazon.awscdk.services.cognito.UserPoolEmail
Pythonaws_cdk.aws_cognito.UserPoolEmail
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolEmail

Configure how Cognito sends emails.

Example

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

Initializer

new UserPoolEmail()

Methods

NameDescription
static withCognito(replyTo?)Send email using Cognito.
static withSES(options)Send email using SES.

static withCognito(replyTo?)

public static withCognito(replyTo?: string): UserPoolEmail

Parameters

  • replyTo string

Returns

  • UserPoolEmail

Send email using Cognito.


static withSES(options)

public static withSES(options: UserPoolSESOptions): UserPoolEmail

Parameters

  • options UserPoolSESOptions

Returns

  • UserPoolEmail

Send email using SES.