Class UserPoolSESOptions

Configuration for Cognito sending emails via Amazon SES.

Inheritance
System.Object
UserPoolSESOptions
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class UserPoolSESOptions : Object, IUserPoolSESOptions
Syntax (vb)
Public Class UserPoolSESOptions
    Inherits Object
    Implements IUserPoolSESOptions
Remarks

ExampleMetadata: infused

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"
    })
});

Synopsis

Constructors

UserPoolSESOptions()

Properties

ConfigurationSetName

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

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

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

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

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

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

Constructors

UserPoolSESOptions()

public UserPoolSESOptions()

Properties

ConfigurationSetName

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

public string ConfigurationSetName { get; set; }
Property Value

System.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.

public string FromEmail { get; set; }
Property Value

System.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.

public string FromName { get; set; }
Property Value

System.String

Remarks

Default: - no name

ReplyTo

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

public string ReplyTo { get; set; }
Property Value

System.String

Remarks

Default: - same as the fromEmail

SesRegion

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

public string SesRegion { get; set; }
Property Value

System.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.

public string SesVerifiedDomain { get; set; }
Property Value

System.String

Remarks

Default: - no domain

Implements