Table of Contents

Interface IUserPoolSESOptions

Namespace
Amazon.CDK.AWS.Cognito
Assembly
Amazon.CDK.AWS.Cognito.dll

Configuration for Cognito sending emails via Amazon SES.

public interface IUserPoolSESOptions

Examples

new UserPool(this, "myuserpool", new UserPoolProps {
                Email = UserPoolEmail.WithSES(new UserPoolSESOptions {
                    SesRegion = "us-east-1",
                    FromEmail = "noreply@myawesomeapp.com",
                    FromName = "Awesome App",
                    ReplyTo = "support@myawesomeapp.com"
                })
            });

Remarks

ExampleMetadata: infused

Properties

ConfigurationSetName

The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.

string? ConfigurationSetName { get; }

Property Value

string

Remarks

Default: - no configuration set

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-configurationset

FromEmail

The verified Amazon SES email address that Cognito should use to send emails.

string FromEmail { get; }

Property Value

string

Remarks

The email address used must be a verified email address in Amazon SES and must be configured to allow Cognito to send emails.

See: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html

FromName

An optional name that should be used as the sender's name along with the email.

string? FromName { get; }

Property Value

string

Remarks

Default: - no name

ReplyTo

The destination to which the receiver of the email should reploy to.

string? ReplyTo { get; }

Property Value

string

Remarks

Default: - same as the fromEmail

SesRegion

Required if the UserPool region is different than the SES region.

string? SesRegion { get; }

Property Value

string

Remarks

If sending emails with a Amazon SES verified email address, and the region that SES is configured is different than the region in which the UserPool is deployed, you must specify that region here.

Must be 'us-east-1', 'us-west-2', or 'eu-west-1'

Default: - The same region as the Cognito UserPool

SesVerifiedDomain

SES Verified custom domain to be used to verify the identity.

string? SesVerifiedDomain { get; }

Property Value

string

Remarks

Default: - no domain