UserPoolEmailConfig

class aws_cdk.aws_cognito.UserPoolEmailConfig(*, configuration_set=None, email_sending_account=None, from_=None, reply_to_email_address=None, source_arn=None)

Bases: object

Result of binding email settings with a user pool.

Parameters:

  • configuration_set (Optional[str]) – The name of the configuration set in SES. Default: - none

  • email_sending_account (Optional[str]) – Specifies whether to use Cognito’s built in email functionality or SES. Default: - Cognito built in email functionality

  • from – Identifies either the sender’s email address or the sender’s name with their email address. If emailSendingAccount is DEVELOPER then this cannot be specified. Default: ‘no-reply@verificationemail.com’

  • reply_to_email_address (Optional[str]) – The destination to which the receiver of the email should reply to. Default: - same as from

  • source_arn (Optional[str]) – The ARN of a verified email address in Amazon SES. required if emailSendingAccount is DEVELOPER or if ‘from’ is provided. Default: - none

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

user_pool_email_config = cognito.UserPoolEmailConfig(
    configuration_set="configurationSet",
    email_sending_account="emailSendingAccount",
    from="from",
    reply_to_email_address="replyToEmailAddress",
    source_arn="sourceArn"
)

Attributes

configuration_set

The name of the configuration set in SES.

Default:

  • none

email_sending_account

Specifies whether to use Cognito’s built in email functionality or SES.

Default:

  • Cognito built in email functionality

from_

Identifies either the sender’s email address or the sender’s name with their email address.

If emailSendingAccount is DEVELOPER then this cannot be specified.

Default:

‘no-reply@verificationemail.com’

reply_to_email_address

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

Default:

  • same as from

source_arn

The ARN of a verified email address in Amazon SES.

required if emailSendingAccount is DEVELOPER or if ‘from’ is provided.

Default:

  • none