Interface UserPoolSESOptions

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.105Z") @Stability(Stable) public interface UserPoolSESOptions extends
Configuration for Cognito sending emails via Amazon SES.


 UserPool.Builder.create(this, "myuserpool")
                 .fromName("Awesome App")
  • Method Details

    • getFromEmail

      @Stability(Stable) @NotNull String getFromEmail()
      The verified Amazon SES email address that Cognito should use to send emails.

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

      See Also:
    • getConfigurationSetName

      @Stability(Stable) @Nullable default String getConfigurationSetName()
      The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.

      Default: - no configuration set

      See Also:
    • getFromName

      @Stability(Stable) @Nullable default String getFromName()
      An optional name that should be used as the sender's name along with the email.

      Default: - no name

    • getReplyTo

      @Stability(Stable) @Nullable default String getReplyTo()
      The destination to which the receiver of the email should reploy to.

      Default: - same as the fromEmail

    • getSesRegion

      @Stability(Stable) @Nullable default String getSesRegion()
      Required if the UserPool region is different than the SES region.

      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

    • getSesVerifiedDomain

      @Stability(Stable) @Nullable default String getSesVerifiedDomain()
      SES Verified custom domain to be used to verify the identity.

      Default: - no domain

    • builder

      @Stability(Stable) static UserPoolSESOptions.Builder builder()
      a UserPoolSESOptions.Builder of UserPoolSESOptions