interface UserPoolEmailConfig
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Cognito.UserPoolEmailConfig |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolEmailConfig |
 Java | software.amazon.awscdk.services.cognito.UserPoolEmailConfig |
 Python | aws_cdk.aws_cognito.UserPoolEmailConfig |
 TypeScript (source) | aws-cdk-lib » aws_cognito » UserPoolEmailConfig |
Result of binding email settings with a user pool.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const userPoolEmailConfig: cognito.UserPoolEmailConfig = {
configurationSet: 'configurationSet',
emailSendingAccount: 'emailSendingAccount',
from: 'from',
replyToEmailAddress: 'replyToEmailAddress',
sourceArn: 'sourceArn',
};
Properties
| Name | Type | Description |
|---|---|---|
| configuration | string | The name of the configuration set in SES. |
| email | string | Specifies whether to use Cognito's built in email functionality or SES. |
| from? | string | Identifies either the sender's email address or the sender's name with their email address. |
| reply | string | The destination to which the receiver of the email should reply to. |
| source | string | The ARN of a verified email address in Amazon SES. |
configurationSet?
Type:
string
(optional, default: none)
The name of the configuration set in SES.
emailSendingAccount?
Type:
string
(optional, default: Cognito built in email functionality)
Specifies whether to use Cognito's built in email functionality or SES.
from?
Type:
string
(optional, default: 'no-reply@verificationemail.com')
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.
replyToEmailAddress?
Type:
string
(optional, default: same as from)
The destination to which the receiver of the email should reply to.
sourceArn?
Type:
string
(optional, default: none)
The ARN of a verified email address in Amazon SES.
required if emailSendingAccount is DEVELOPER or if 'from' is provided.